@wpkernel/pipeline v0.12.1-beta.3

---

@wpkernel/pipeline / Pipeline

Interface: Pipeline<TRunOptions, TRunResult, TContext, TReporter, TBuildOptions, TArtifact, TFragmentInput, TFragmentOutput, TBuilderInput, TBuilderOutput, TDiagnostic, TFragmentKind, TBuilderKind, TFragmentHelper, TBuilderHelper>

A pipeline instance with helper registration and execution methods.

Type Parameters

TRunOptions

TRunOptions

TRunResult

TRunResult

TContext

TContext extends object

TReporter

TReporter extends PipelineReporter = PipelineReporter

TBuildOptions

TBuildOptions = unknown

TArtifact

TArtifact = unknown

TFragmentInput

TFragmentInput = unknown

TFragmentOutput

TFragmentOutput = unknown

TBuilderInput

TBuilderInput = unknown

TBuilderOutput

TBuilderOutput = unknown

TDiagnostic

TDiagnostic extends PipelineDiagnostic = PipelineDiagnostic

TFragmentKind

TFragmentKind extends HelperKind = "fragment"

TBuilderKind

TBuilderKind extends HelperKind = "builder"

TFragmentHelper

TFragmentHelper extends Helper<TContext, TFragmentInput, TFragmentOutput, TReporter, TFragmentKind> = Helper<TContext, TFragmentInput, TFragmentOutput, TReporter, TFragmentKind>

TBuilderHelper

TBuilderHelper extends Helper<TContext, TBuilderInput, TBuilderOutput, TReporter, TBuilderKind> = Helper<TContext, TBuilderInput, TBuilderOutput, TReporter, TBuilderKind>

Properties

builderKind

readonly builderKind: TBuilderKind;

---

builders

readonly builders: object;

use()

use: (helper) => void;

Parameters

helper

TBuilderHelper

Returns

void

---

extensions

readonly extensions: object;

use()

use: (extension) => unknown;

Parameters

extension

PipelineExtension<Pipeline<TRunOptions, TRunResult, TContext, TReporter, TBuildOptions, TArtifact, TFragmentInput, TFragmentOutput, TBuilderInput, TBuilderOutput, TDiagnostic, TFragmentKind, TBuilderKind, TFragmentHelper, TBuilderHelper>, TContext, TRunOptions, TArtifact>

Returns

unknown

---

fragmentKind

readonly fragmentKind: TFragmentKind;

---

ir

readonly ir: object;

use()

use: (helper) => void;

Parameters

helper

TFragmentHelper

Returns

void

---

run()

run: (options) => MaybePromise<TRunResult>;

Parameters

options

TRunOptions

Returns

MaybePromise<TRunResult>

---

use()

use: (helper) => void;

Parameters

helper

TFragmentHelper | TBuilderHelper

Returns

void