Skip to content

js-bao-wss-client


js-bao-wss-client / WorkflowStatusValue

Type Alias: WorkflowStatusValue ​

WorkflowStatusValue = "queued" | "running" | "apply_pending" | "apply_claimed" | "completed" | "failed" | "terminated" | "missing" | "skipped"

Status reported by workflows.getStatus() and workflows.terminate().

The server reconciles the run's status and returns exactly one of these values — the same canonical set as WorkflowRunStatus, the workflowStatus event, runSync, and the persisted run.status. Raw platform spellings never reach the client, so no client-side mapping is needed: read the value as-is.

  • queued / running — still in flight.
  • apply_pending / apply_claimed — the run finished its server-side work and is waiting for a client-side apply step.
  • completed / failed / terminated — terminal.
  • skipped — terminal: the run did not run because its declarative lock was held and the workflow declared onContention = "ignore". Read skipReason for why; it carries no error.
  • missing — the run record no longer resolves to a live execution.
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