PersistentAI API Documentation / @persistent-ai/fireflow-types / INonDurableClient
Interface: INonDurableClient
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:254
Abstract client interface for non-durable workflow operations.
Implementations use DBOSClient under the hood, but this interface avoids a direct dependency on @dbos-inc/dbos-sdk in fireflow-types.
Properties
enqueueWorkflow()
enqueueWorkflow: (
options, ...args) =>Promise<INonDurableWorkflowHandle<unknown>>
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:259
Enqueue a workflow for execution. Returns a handle for tracking the enqueued workflow.
Parameters
options
appVersion
string
deduplicationID
string
queueName
string
workflowClassName
string
workflowID
string
workflowName
string
args
...any[]
Returns
Promise<INonDurableWorkflowHandle<unknown>>
getEvent()
getEvent: <
T>(workflowId,key,timeoutSeconds?) =>Promise<T|null>
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:271
Get an event value from a workflow (non-durable, external read).
Type Parameters
T
T
Parameters
workflowId
string
key
string
timeoutSeconds?
number
Returns
Promise<T | null>
getWorkflow()
getWorkflow: (
workflowId) =>Promise<{status:string; } |undefined>
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:286
Get workflow status.
Parameters
workflowId
string
Returns
Promise<{ status: string; } | undefined>
retrieveWorkflow()
retrieveWorkflow: <
T>(workflowId) =>INonDurableWorkflowHandle<T>
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:281
Retrieve a workflow handle by ID.
Type Parameters
T
T
Parameters
workflowId
string
Returns
send()
send: <
T>(destinationId,message,topic?) =>Promise<void>
Defined in: packages/fireflow-types/src/execution/services/dbos-types.ts:276
Send a message to a workflow.
Type Parameters
T
T
Parameters
destinationId
string
message
T
topic?
string
Returns
Promise<void>