Workflow Docs
AI/LLM: This documentation page is available in plain markdown format at/workflow/latest/docs/reference/interfaces/WaitForEventOptions.md
WaitForEventOptions
Interface: WaitForEventOptions<TPayload>#
Defined in: packages/workflow-core/src/types.ts:266
Extends#
Type Parameters#
TPayload#
TPayload = unknown
Properties#
deadline?#
ts
optional deadline: number;Defined in: packages/workflow-core/src/types.ts:271
UTC ms wake deadline. Surfaced on RunState.waitingFor.deadline so hosts can build time-indexed worker jobs.
id?#
ts
optional id: string;Defined in: packages/workflow-core/src/types.ts:30
Stable durable-operation identifier. Supplying this lets replay find the right log record even if surrounding operations are reordered in a later workflow version.
Inherited from#
meta?#
ts
optional meta: WorkflowMetadata;Defined in: packages/workflow-core/src/types.ts:273
Free-form metadata the host or UI may render.
Overrides#
schema?#
ts
optional schema: StandardSchemaV1<unknown, TPayload>;Defined in: packages/workflow-core/src/types.ts:276
Optional schema for validating the incoming payload before resuming the workflow.