Skip to content

Commit a40db73

Browse files
committed
docs: update api docs
1 parent 4b1f6aa commit a40db73

27 files changed

Lines changed: 344 additions & 344 deletions

data/api/builder.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"name": "builder",
33
"specifier": "@probitas/builder",
4-
"version": "0.3.0",
4+
"version": "0.3.1",
55
"moduleDoc": "Builder module for creating scenario definitions with a fluent, type-safe API.\n\nThis package provides the {@linkcode scenario} fn function that returns a builder\nfor constructing scenario definitions. The builder uses method chaining to define\nresources, setup functions, and test steps with full TypeScript type inference.\n\n## Links\n\n- [GitHub Repository](https://github.com/jsr-probitas/probitas)\n- [@probitas/probitas](https://jsr.io/@probitas/probitas) - Main package (recommended for most users)\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [@probitas/core](https://jsr.io/@probitas/core) | Core type definitions used by this builder |\n| [@probitas/runner](https://jsr.io/@probitas/runner) | Executes scenarios built with this package |\n\n## Key Features\n\n- **Fluent API**: Chain methods naturally to build complex scenarios\n- **Type-safe context**: Each step receives typed access to previous step results\n- **Resource management**: Register resources with automatic lifecycle handling\n- **Setup/Cleanup**: Define setup functions with automatic cleanup support\n- **Configurable defaults**: Override timeout and retry settings at any level\n\n## Core Exports\n\n- {@linkcode scenario} - Factory function to create a new scenario builder\n- {@linkcode StepContext} - Type representing the context passed to step functions\n- {@linkcode StepFunction} - Type signature for step functions\n- {@linkcode SetupFunction} - Type signature for setup functions\n- {@linkcode ResourceFunction} - Type signature for resource fn functions\n- {@linkcode BuilderScenarioOptions} - Partial options for scenario configuration\n- {@linkcode BuilderStepOptions} - Partial options for step configuration\n- {@linkcode DEFAULT_SCENARIO_OPTIONS} - Default values for scenario options\n- {@linkcode DEFAULT_STEP_OPTIONS} - Default values for step options\n",
66
"exports": [
77
{
88
"name": "scenario",
99
"isDefault": false,
1010
"location": {
11-
"filename": "https://jsr.io/@probitas/builder/0.3.0/scenario_builder.ts",
11+
"filename": "https://jsr.io/@probitas/builder/0.3.1/scenario_builder.ts",
1212
"line": 571,
1313
"col": 0,
1414
"byteIndex": 18358
@@ -102,7 +102,7 @@
102102
"name": "BuilderStepContext",
103103
"isDefault": false,
104104
"location": {
105-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
105+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
106106
"line": 40,
107107
"col": 0,
108108
"byteIndex": 1233
@@ -163,7 +163,7 @@
163163
"doc": "Result from the previous step.\n\nFully typed based on what the previous step returned.\nFor the first step, this is `unknown`."
164164
},
165165
"location": {
166-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
166+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
167167
"line": 51,
168168
"col": 2,
169169
"byteIndex": 1574
@@ -188,7 +188,7 @@
188188
"doc": "All accumulated results as a typed tuple.\n\nAllows accessing any previous result by index:\n```ts\nctx.results[0] // First step's result\nctx.results[1] // Second step's result\n```"
189189
},
190190
"location": {
191-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
191+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
192192
"line": 62,
193193
"col": 2,
194194
"byteIndex": 1824
@@ -213,7 +213,7 @@
213213
"doc": "Named resources registered with `.resource()`.\n\nResources are typed based on their registration:\n```ts\n.resource(\"db\", () => createDbConnection())\n.step((ctx) => ctx.resources.db.query(...))\n```"
214214
},
215215
"location": {
216-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
216+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
217217
"line": 73,
218218
"col": 2,
219219
"byteIndex": 2089
@@ -331,7 +331,7 @@
331331
"name": "BuilderStepFunction",
332332
"isDefault": false,
333333
"location": {
334-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
334+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
335335
"line": 102,
336336
"col": 0,
337337
"byteIndex": 2903
@@ -551,7 +551,7 @@
551551
"name": "BuilderStepDefinition",
552552
"isDefault": false,
553553
"location": {
554-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
554+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
555555
"line": 124,
556556
"col": 0,
557557
"byteIndex": 3678
@@ -613,7 +613,7 @@
613613
"doc": "Step function to execute"
614614
},
615615
"location": {
616-
"filename": "https://jsr.io/@probitas/builder/0.3.0/types.ts",
616+
"filename": "https://jsr.io/@probitas/builder/0.3.1/types.ts",
617617
"line": 131,
618618
"col": 2,
619619
"byteIndex": 3918
@@ -769,5 +769,5 @@
769769
}
770770
}
771771
],
772-
"generatedAt": "2025-12-16T07:16:29.870Z"
772+
"generatedAt": "2025-12-16T18:17:30.878Z"
773773
}

data/api/client-connectrpc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4563,5 +4563,5 @@
45634563
}
45644564
}
45654565
],
4566-
"generatedAt": "2025-12-16T07:16:29.918Z"
4566+
"generatedAt": "2025-12-16T18:17:30.930Z"
45674567
}

data/api/client-deno-kv.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2971,5 +2971,5 @@
29712971
}
29722972
}
29732973
],
2974-
"generatedAt": "2025-12-16T07:16:29.940Z"
2974+
"generatedAt": "2025-12-16T18:17:30.956Z"
29752975
}

data/api/client-graphql.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2363,5 +2363,5 @@
23632363
}
23642364
}
23652365
],
2366-
"generatedAt": "2025-12-16T07:16:29.964Z"
2366+
"generatedAt": "2025-12-16T18:17:30.981Z"
23672367
}

data/api/client-grpc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3552,5 +3552,5 @@
35523552
}
35533553
}
35543554
],
3555-
"generatedAt": "2025-12-16T07:16:29.989Z"
3555+
"generatedAt": "2025-12-16T18:17:31.008Z"
35563556
}

data/api/client-http.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3075,5 +3075,5 @@
30753075
}
30763076
}
30773077
],
3078-
"generatedAt": "2025-12-16T07:16:30.011Z"
3078+
"generatedAt": "2025-12-16T18:17:31.030Z"
30793079
}

data/api/client-mongodb.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3895,5 +3895,5 @@
38953895
}
38963896
}
38973897
],
3898-
"generatedAt": "2025-12-16T07:16:30.047Z"
3898+
"generatedAt": "2025-12-16T18:17:31.066Z"
38993899
}

data/api/client-rabbitmq.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3875,5 +3875,5 @@
38753875
}
38763876
}
38773877
],
3878-
"generatedAt": "2025-12-16T07:16:30.072Z"
3878+
"generatedAt": "2025-12-16T18:17:31.091Z"
38793879
}

data/api/client-redis.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4155,5 +4155,5 @@
41554155
}
41564156
}
41574157
],
4158-
"generatedAt": "2025-12-16T07:16:30.098Z"
4158+
"generatedAt": "2025-12-16T18:17:31.119Z"
41594159
}

data/api/client-sql-duckdb.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3541,5 +3541,5 @@
35413541
}
35423542
}
35433543
],
3544-
"generatedAt": "2025-12-16T07:16:30.134Z"
3544+
"generatedAt": "2025-12-16T18:17:31.155Z"
35453545
}

0 commit comments

Comments
 (0)