Skip to content

Graphorin API reference v0.8.0


Graphorin API reference / @graphorin/proactive / / workflowAwakeableOutcome

Function: workflowAwakeableOutcome()

ts
function workflowAwakeableOutcome(args): 
  | ProactiveQuestionOutcome
  | ProactiveReviewOutcome;

Defined in: packages/proactive/src/ladder.ts:88

Build a question / review outcome for a task parked inside a durable WORKFLOW (awaitExternal / requestApproval): the resolve ref is the serialized awakeable address (wf:<workflowId>:<threadId>: <name>, decision D-1/A3), resolved through the existing POST /v1/workflows/:id/resume route and ticked by the workflow timer-daemon - this package composes with that daemon, it never re-hosts it (D-9).

Parameters

ParameterType
args{ firedAt?: string; kind: "question" | "review"; name: string; options?: readonly ProactiveOutcomeOption[]; sessionId?: string; taskId: string; text: string; threadId: string; workflowId: string; }
args.firedAt?string
args.kind"question" | "review"
args.namestring
args.options?readonly ProactiveOutcomeOption[]
args.sessionId?string
args.taskIdstring
args.textstring
args.threadIdstring
args.workflowIdstring

Returns

| ProactiveQuestionOutcome | ProactiveReviewOutcome

Stable