Stone.js API
    Preparing search index...

    Class Pipeline<T, R, Args>

    Class representing a Pipeline.

    Type Parameters

    • T = unknown

      The type of the passable object in the pipeline.

    • R = T

      The type of the return value from the pipeline execution.

      This class is responsible for managing and executing a series of operations on a set of passable values through multiple configurable pipes.

    • Args extends any[] = any[]
    Index
    • Initialize a new Pipeline instance.

      Type Parameters

      • T = unknown

        The type of the passable object in the pipeline.

      • R = T

        The type of the return value from the pipeline execution.

        This class is responsible for managing and executing a series of operations on a set of passable values through multiple configurable pipes.

      • Args extends any[] = any[]

      Parameters

      Returns Pipeline<T, R, Args>

    • Set the default priority for pipes in the pipeline.

      Parameters

      • value: number

        The priority value to set.

      Returns this

      The current Pipeline instance.

    • Add additional pipes to the pipeline.

      Parameters

      • ...pipe: MixedPipe<T, R, Args>[]

        A single pipe or a list of pipes to add.

      Returns this

      The current Pipeline instance.

    • Set the passable objects being sent through the pipeline.

      Parameters

      • passable: T

        The object to pass through the pipeline.

      Returns this

      The current Pipeline instance.

    • Configure the pipeline to run synchronously or asynchronously.

      Parameters

      • value: boolean = true

        Set true for sync, false for async (default is true).

      Returns this

      The current Pipeline instance.

    • Run the pipeline with a final destination callback.

      Parameters

      Returns Promiseable<R>

      The result of the pipeline, either synchronously or as a Promise.

    • Run the pipeline and return the result.

      Returns Promiseable<R>

      The result of the pipeline, either synchronously or as a Promise.

    • Set the pipes for the pipeline.

      Parameters

      Returns this

      The current Pipeline instance.

    • Set the method to call on each pipe.

      Parameters

      • method: string

        The method name to use on each pipe.

      Returns this

      The current Pipeline instance.