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]>

Author: adriandlam

.changeset/twenty-clouds-smoke.md

@@ -0,0 +1,5 @@
+---
+"workflow": patch
+---
+
+Export WorkflowReadableStreamOptions from workflow/api

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

@@ -42,6 +42,16 @@ export default Run;`
 showSections={['returns']}
 />
 
+#### WorkflowReadableStreamOptions
+
+<TSDoc
+definition={generateDefinition({
+  code: `
+import type { WorkflowReadableStreamOptions } from 'workflow/api';
+export default WorkflowReadableStreamOptions;`
+})}
+/>
+
 ## Examples
 
 ### Basic Status Check

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

@@ -51,6 +51,8 @@ export default Run;`
 showSections={['returns']}
 />
 
+Learn more about [`WorkflowReadableStreamOptions`](/docs/api-reference/workflow-api/get-run#workflowreadablestreamoptions).
+
 ## Good to Know
 
 * The `start()` function is used in runtime/non-workflow contexts to programmatically trigger workflow executions.

packages/workflow/src/api.ts

@@ -8,5 +8,6 @@ export {
   runStep,
   type StartOptions,
   start,
+  type WorkflowReadableStreamOptions,
   type WorkflowRun,
 } from '@workflow/core/runtime';