Skip to content

js-bao-wss-client


js-bao-wss-client / TerminateWorkflowOptions

Interface: TerminateWorkflowOptions ​

Options for terminating a workflow

Properties ​

contextDocId? ​

optional contextDocId?: string

Document ID the workflow is scoped to. Uses user's root document if not provided.


runKey ​

runKey: string

The run key identifying this workflow run


workflowKey ​

workflowKey: string

The workflow key identifying which workflow this run belongs to

Documentation validated against js-bao-wss-client 3.4.0 · js-bao 0.11.0 · primitive-admin 1.0.62 · primitive-app 3.1.0 — 2026-09-30