@rtorcato/cf-common
Interfaces
WorkflowClient
Defined in: index.ts:9
A typed client over one Workflow binding.
Type Parameters
Params
Params
Result
Result
Methods
create()
create(
params,options?):Promise<WorkflowInstance>
Defined in: index.ts:14
Start a new instance. Pass id to choose it (it must be unique within the
Workflow); omit it and Cloudflare generates one. Throws WORKFLOW_FAILED.
Parameters
params
Params
options?
Omit<WorkflowInstanceCreateOptions<Params>, "params">
Returns
Promise<WorkflowInstance>
get()
get(
id):Promise<WorkflowInstance>
Defined in: index.ts:19
Get a handle to an existing instance. Throws WORKFLOW_FAILED if it doesn't exist.
Parameters
id
string
Returns
Promise<WorkflowInstance>
status()
status(
id):Promise<WorkflowStatus<Result>>
Defined in: index.ts:21
Read an instance's status, with output typed as Result. Throws WORKFLOW_FAILED.
Parameters
id
string
Returns
Promise<WorkflowStatus<Result>>
Type Aliases
WorkflowStatus
WorkflowStatus<
Result> =Omit<InstanceStatus,"output"> &object
Defined in: index.ts:4
What status() reports. output is whatever the Workflow's run returned.
Type Parameters
Result
Result = unknown
Type Declaration
output?
optionaloutput?:Result
Functions
createWorkflow()
createWorkflow<
Params,Result>(workflow):WorkflowClient<Params,Result>
Defined in: index.ts:37
Wrap a Workflow binding so create takes typed params, status returns a
typed output, and failures surface as a CloudflareError.
The Workflow class itself is WorkflowEntrypoint from cloudflare:workers,
already typed by @cloudflare/workers-types (event.payload, step.do,
step.sleep). This is the caller's side of it.
Example
const signups = createWorkflow<{ email: string }, { userId: string }>(env.SIGNUP)
const instance = await signups.create({ email: 'ada@example.com' }, { id: 'ada' })
const { status, output } = await signups.status(instance.id)
Type Parameters
Params
Params = unknown
Result
Result = unknown
Parameters
workflow
Workflow<Params>
Returns
WorkflowClient<Params, Result>