Interface Pipeline<T>

A pipeline is a collection of steps that are executed in a certain order. It is to be created createPipeline.

If you want to get the type of all steps in the pipeline (given they are created canonically using const step names), refer to PipelineStepNames.

interface Pipeline<T extends IPipelineStep = IPipelineStep> {
    firstStepPerRequest: number;
    order: readonly T["name"][];
    steps: ReadonlyMap<
        PipelineStepName,
        {
            decorates?: PipelineStepName;
            dependencies: readonly PipelineStepName[];
            description: string;
            executed: PipelineStepStage;
            humanReadableName: string;
            name: PipelineStepName;
            printer: {
                "0": (input: any) => any & InternalStepPrinter<
                    (...args: any[]) => any,
                >;
                "1"?: (input: any, ...additional: never[]) => string | Promise<string>;
                "2"?: (input: any, ...additional: never[]) => string | Promise<string>;
                "3"?: (input: any, ...additional: never[]) => string | Promise<string>;
                "4"?: (input: any, ...additional: never[]) => string | Promise<string>;
                "5"?: (input: any, ...additional: never[]) => string | Promise<string>;
            };
            processor: (...input: any[]) => any;
            requiredInput: object;
            readonly [key: string]: unknown;
        },
    >;
}

Type Parameters

Properties

firstStepPerRequest order steps

Properties

ReadonlyfirstStepPerRequest

firstStepPerRequest: number

In the order, this is the index of the first step that is executed PipelineStepStage#OncePerRequest|once per request. If it is "out of bounds" (i.e., the number of steps), all steps are executed PipelineStepStage#OncePerFile|once per file.

Readonlyorder

order: readonly T["name"][]

Readonlysteps

steps: ReadonlyMap<
    PipelineStepName,
    {
        decorates?: PipelineStepName;
        dependencies: readonly PipelineStepName[];
        description: string;
        executed: PipelineStepStage;
        humanReadableName: string;
        name: PipelineStepName;
        printer: {
            "0": (input: any) => any & InternalStepPrinter<
                (...args: any[]) => any,
            >;
            "1"?: (input: any, ...additional: never[]) => string | Promise<string>;
            "2"?: (input: any, ...additional: never[]) => string | Promise<string>;
            "3"?: (input: any, ...additional: never[]) => string | Promise<string>;
            "4"?: (input: any, ...additional: never[]) => string | Promise<string>;
            "5"?: (input: any, ...additional: never[]) => string | Promise<string>;
        };
        processor: (...input: any[]) => any;
        requiredInput: object;
        readonly [key: string]: unknown;
    },
>

Settings

Member Visibility

On This Page

Properties