Class FlowProducer

FlowProducer creates job flows with automatic dependencies.

Example

const flow = new FlowProducer();

// Simple chain: A → B → C
const { jobIds } = await flow.addChain([
  { name: 'fetch', queueName: 'pipeline', data: { url: '...' } },
  { name: 'process', queueName: 'pipeline', data: {} },
  { name: 'store', queueName: 'pipeline', data: {} },
]);

// Parallel then merge
const result = await flow.addBulkThen(
  [
    { name: 'task1', queueName: 'parallel', data: { id: 1 } },
    { name: 'task2', queueName: 'parallel', data: { id: 2 } },
  ],
  { name: 'merge', queueName: 'final', data: {} }
);

Hierarchy

EventEmitter
- FlowProducer

Index

Constructors

constructor

new FlowProducer(opts?: FlowProducerOptions): FlowProducer
Parameters
- opts: FlowProducerOptions = {}
Returns FlowProducer
Overrides EventEmitter.constructor
- Defined in client/flow.ts:73

Properties

closing

closing: Promise<void> = ...

Methods

add

add<T = unknown>(flow: FlowJob<T>, opts?: FlowOpts): Promise<JobNode<T>>
Add a flow (BullMQ v5 compatible). Children are processed BEFORE their parent.
Type Parameters
- T = unknown
Parameters
- flow: FlowJob<T>
- Optionalopts: FlowOpts
Returns Promise<JobNode<T>>
- Defined in client/flow.ts:149

addBulk

addBulk<T = unknown>(flows: FlowJob<T>[]): Promise<JobNode<T>[]>
Add multiple flows (BullMQ v5 compatible).
Type Parameters
- T = unknown
Parameters
- flows: FlowJob<T>[]
Returns Promise<JobNode<T>[]>
- Defined in client/flow.ts:156

addBulkThen

addBulkThen<T = unknown>(
parallel: FlowStep<T>[],
final: FlowStep<T>,
): Promise<{ finalId: string; parallelIds: string[] }>
Add parallel jobs that converge to a final job.
Type Parameters
- T = unknown
Parameters
- parallel: FlowStep<T>[]
- final: FlowStep<T>
Returns Promise<{ finalId: string; parallelIds: string[] }>
- Defined in client/flow.ts:188

addChain

addChain<T = unknown>(steps: FlowStep<T>[]): Promise<FlowResult>
Add a chain of jobs. Jobs execute sequentially: step[0] → step[1] → ...
Type Parameters
- T = unknown
Parameters
- steps: FlowStep<T>[]
Returns Promise<FlowResult>
- Defined in client/flow.ts:180

addTree

addTree<T = unknown>(root: FlowStep<T>): Promise<FlowResult>
Add a tree of jobs where children depend on parent.
Type Parameters
- T = unknown
Parameters
- root: FlowStep<T>
Returns Promise<FlowResult>
- Defined in client/flow.ts:201

close

close(): Promise<void>
Close the connection pool (only if using dedicated pool)

Returns Promise<void>
- Defined in client/flow.ts:121

disconnect

disconnect(): Promise<void>
Disconnect from the server (BullMQ v5 compatible). Alias for close().

Returns Promise<void>
- Defined in client/flow.ts:134

getFlow

getFlow<T = unknown>(opts: GetFlowOpts): Promise<JobNode<T> | null>
Get a flow tree starting from a job (BullMQ v5 compatible).
Type Parameters
- T = unknown
Parameters
- opts: GetFlowOpts
Returns Promise<JobNode<T> | null>
- Defined in client/flow.ts:164

getParentResult

getParentResult<R = unknown>(parentId: string): R | undefined
Get the result of a completed parent job (embedded only).
Type Parameters
- R = unknown
  Type of the job result
Parameters
- parentId: string
Returns R | undefined
- Defined in client/flow.ts:212

getParentResults

getParentResults<R = unknown>(parentIds: string[]): Map<string, R>
Get results from multiple parent jobs (embedded only).
Type Parameters
- R = unknown
  Type of the job results
Parameters
- parentIds: string[]
Returns Map<string, R>
- Defined in client/flow.ts:221

waitUntilReady

waitUntilReady(): Promise<void>
Wait until the FlowProducer is ready (BullMQ v5 compatible).

Returns Promise<void>
- Defined in client/flow.ts:139

Class FlowProducer

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowProducer

Properties

closing

Methods

add

Type Parameters

Parameters

Returns Promise<JobNode<T>>

addBulk

Type Parameters

Parameters

Returns Promise<JobNode<T>[]>

addBulkThen

Type Parameters

Parameters

Returns Promise<{ finalId: string; parallelIds: string[] }>

addChain

Type Parameters

Parameters

Returns Promise<FlowResult>

addTree

Type Parameters

Parameters

Returns Promise<FlowResult>

close

Returns Promise<void>

disconnect

Returns Promise<void>

getFlow

Type Parameters

Parameters

Returns Promise<JobNode<T> | null>

getParentResult

Type Parameters

Parameters

Returns R | undefined

getParentResults

Type Parameters

Parameters

Returns Map<string, R>

waitUntilReady

Returns Promise<void>

Settings

On This Page