@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / Flow
Class: Flow<State>
Type Parameters
• State
Implements
Constructors
new Flow()
new Flow<
State>(queueImpl,flowId,state,sequencerId):Flow<State>
Parameters
• queueImpl: TaskQueue
• flowId: string
• state: State
• sequencerId: string
Returns
Flow<State>
Defined in
packages/sequencer/src/worker/flow/Flow.ts:43
Properties
flowId
readonlyflowId:string
Defined in
packages/sequencer/src/worker/flow/Flow.ts:45
sequencerId
readonlysequencerId:string
Defined in
packages/sequencer/src/worker/flow/Flow.ts:47
state
state:
State
Defined in
packages/sequencer/src/worker/flow/Flow.ts:46
tasksInProgress
tasksInProgress:
number=0
Defined in
packages/sequencer/src/worker/flow/Flow.ts:41
Methods
close()
close():
Promise<void>
Returns
Promise<void>
Implementation of
Defined in
packages/sequencer/src/worker/flow/Flow.ts:180
forEach()
forEach<
Type>(inputs,fun):Promise<void>
Type Parameters
• Type
Parameters
• inputs: Type[]
• fun
Returns
Promise<void>
Defined in
packages/sequencer/src/worker/flow/Flow.ts:159
pushTask()
pushTask<
Input,Result>(task,input,completed?,overrides?):Promise<void>
Type Parameters
• Input
• Result
Parameters
• task: Task<Input, Result>
• input: Input
• completed?: CompletedCallback<Input, Result>
• overrides?
• overrides.taskName?: string
Returns
Promise<void>
Defined in
packages/sequencer/src/worker/flow/Flow.ts:109
reject()
reject(
error):void
Parameters
• error: Error
Returns
void
Defined in
packages/sequencer/src/worker/flow/Flow.ts:77
resolve()
resolve<
Result>(result):void
Type Parameters
• Result
Parameters
• result: Result
Returns
void
Defined in
packages/sequencer/src/worker/flow/Flow.ts:70
withFlow()
withFlow<
Result>(executor):Promise<Result>
Type Parameters
• Result
Parameters
• executor
Returns
Promise<Result>