Skip to content

Commit ad1df0b

Browse files
committed
docs: Update API docs
1 parent 19f3cfe commit ad1df0b

27 files changed

Lines changed: 7578 additions & 7500 deletions

data/api/builder.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"name": "builder",
33
"specifier": "@probitas/builder",
4-
"version": "0.4.2",
4+
"version": "0.4.4",
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/probitas-test/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.4.2/scenario_builder.ts",
11+
"filename": "https://jsr.io/@probitas/builder/0.4.4/scenario_builder.ts",
1212
"line": 644,
1313
"col": 0,
1414
"byteIndex": 20517
@@ -102,7 +102,7 @@
102102
"name": "BuilderStepContext",
103103
"isDefault": false,
104104
"location": {
105-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
105+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
106106
"line": 44,
107107
"col": 0,
108108
"byteIndex": 1337
@@ -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.4.2/types.ts",
166+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
167167
"line": 55,
168168
"col": 2,
169169
"byteIndex": 1678
@@ -188,7 +188,7 @@
188188
"doc": "All accumulated results as a typed tuple.\n\nAllows accessing any previous result by index:\n- `ctx.results[0]` - First step's result\n- `ctx.results[1]` - Second step's result"
189189
},
190190
"location": {
191-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
191+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
192192
"line": 64,
193193
"col": 2,
194194
"byteIndex": 1912
@@ -213,7 +213,7 @@
213213
"doc": "Named resources registered with `.resource()`.\n\nResources are typed based on their registration:\n```ts\nimport { scenario } from \"@probitas/builder\";\n\n// Mock database connection for example\nconst createDbConnection = () => ({ query: (_sql: string) => [{ id: 1 }] });\n\nscenario(\"test\")\n .resource(\"db\", () => createDbConnection())\n .step((ctx) => ctx.resources.db.query(\"SELECT 1\"))\n .build();\n```"
214214
},
215215
"location": {
216-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
216+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
217217
"line": 82,
218218
"col": 2,
219219
"byteIndex": 2415
@@ -331,7 +331,7 @@
331331
"name": "BuilderStepFunction",
332332
"isDefault": false,
333333
"location": {
334-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
334+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
335335
"line": 117,
336336
"col": 0,
337337
"byteIndex": 3428
@@ -551,7 +551,7 @@
551551
"name": "BuilderStepDefinition",
552552
"isDefault": false,
553553
"location": {
554-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
554+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
555555
"line": 139,
556556
"col": 0,
557557
"byteIndex": 4203
@@ -613,7 +613,7 @@
613613
"doc": "Step function to execute"
614614
},
615615
"location": {
616-
"filename": "https://jsr.io/@probitas/builder/0.4.2/types.ts",
616+
"filename": "https://jsr.io/@probitas/builder/0.4.4/types.ts",
617617
"line": 146,
618618
"col": 2,
619619
"byteIndex": 4443

0 commit comments

Comments
 (0)