Skip to content

Commit f563585

Browse files
docs: add WorkflowReadableStreamOptions to start api reference (#100)
* export WorkflowReadableStreamOptions from workflow/api * docs: add WorkflowReadableStreamOptions to start api reference * changeset * docs: update getRun api reference to show WorkflowReadableStreamOptions * refactor: link to WorkflowReadableStreamOptions on getRun docs * Apply suggestion from @TooTallNate --------- Co-authored-by: Nathan Rajlich <[email protected]>
1 parent 7db9e94 commit f563585

File tree

4 files changed

+18
-0
lines changed

4 files changed

+18
-0
lines changed

.changeset/twenty-clouds-smoke.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"workflow": patch
3+
---
4+
5+
Export WorkflowReadableStreamOptions from workflow/api

docs/content/docs/api-reference/workflow-api/get-run.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@ export default Run;`
4242
showSections={['returns']}
4343
/>
4444

45+
#### WorkflowReadableStreamOptions
46+
47+
<TSDoc
48+
definition={generateDefinition({
49+
code: `
50+
import type { WorkflowReadableStreamOptions } from 'workflow/api';
51+
export default WorkflowReadableStreamOptions;`
52+
})}
53+
/>
54+
4555
## Examples
4656

4757
### Basic Status Check

docs/content/docs/api-reference/workflow-api/start.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ export default Run;`
5151
showSections={['returns']}
5252
/>
5353

54+
Learn more about [`WorkflowReadableStreamOptions`](/docs/api-reference/workflow-api/get-run#workflowreadablestreamoptions).
55+
5456
## Good to Know
5557

5658
* The `start()` function is used in runtime/non-workflow contexts to programmatically trigger workflow executions.

packages/workflow/src/api.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ export {
88
runStep,
99
type StartOptions,
1010
start,
11+
type WorkflowReadableStreamOptions,
1112
type WorkflowRun,
1213
} from '@workflow/core/runtime';

0 commit comments

Comments
 (0)