Skip to main content

Class: ParallelGroupBuilder<TContext, TSchemas>

Defined in: packages/workflow-engine/src/core/workflow.ts:538

Collects the members of one parallel execution group. Obtained through WorkflowBuilder.parallel's callback form; every member sees the context accumulated before the group (members cannot depend on each other), and all member outputs become available after it.

Type Parameters​

TContext​

TContext extends Record<string, unknown>

TSchemas​

TSchemas extends Record<string, z.ZodTypeAny> = { }

Constructors​

Constructor​

new ParallelGroupBuilder<TContext, TSchemas>(): ParallelGroupBuilder<TContext, TSchemas>

Returns​

ParallelGroupBuilder<TContext, TSchemas>

Properties​

members​

readonly members: Stage<any, any, any, any, string>[] = []

Defined in: packages/workflow-engine/src/core/workflow.ts:543

Internal

Methods​

stage()​

Call Signature​

stage<TId, TInput, TOutput, TConfig>(id, definition): ParallelGroupBuilder<TContext, TSchemas & { [K in string]: TOutput }>

Defined in: packages/workflow-engine/src/core/workflow.ts:549

Add an inline stage definition to the group. Same shape as WorkflowBuilder.stage.

Type Parameters​
TId​

TId extends string

TInput​

TInput extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | "none"

TOutput​

TOutput extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

TConfig​

TConfig extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Parameters​
id​

TId & UniqueStageId<TId, TContext & TSchemas>

definition​

BuilderStageDefinition<TId, TInput, TOutput, TConfig, TContext>

Returns​

ParallelGroupBuilder<TContext, TSchemas & { [K in string]: TOutput }>

Call Signature​

stage<TStageInput, TStageOutput, TStageConfig, TStageContext, TStageId>(stage): ParallelGroupBuilder<TContext, TSchemas & { [K in string]: TStageOutput }>

Defined in: packages/workflow-engine/src/core/workflow.ts:559

Add a stage built with defineStage to the group.

Type Parameters​
TStageInput​

TStageInput extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

TStageOutput​

TStageOutput extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

TStageConfig​

TStageConfig extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

TStageContext​

TStageContext extends Record<string, unknown>

TStageId​

TStageId extends string

Parameters​
stage​

Stage<TStageInput, TStageOutput, TStageConfig, TStageContext, TStageId> & UniqueStageId<TStageId, TContext & TSchemas>

Returns​

ParallelGroupBuilder<TContext, TSchemas & { [K in string]: TStageOutput }>