@wpkernel/pipeline v0.12.1-beta.3
@wpkernel/pipeline / CreatePipelineOptions
Interface: CreatePipelineOptions<TRunOptions, TBuildOptions, TContext, TReporter, TDraft, TArtifact, TDiagnostic, TRunResult, TFragmentInput, TFragmentOutput, TBuilderInput, TBuilderOutput, TFragmentKind, TBuilderKind, TFragmentHelper, TBuilderHelper>
Options for creating a pipeline.
Type Parameters
TRunOptions
TRunOptions
TBuildOptions
TBuildOptions
TContext
TContext extends object
TReporter
TReporter extends PipelineReporter = PipelineReporter
TDraft
TDraft = unknown
TArtifact
TArtifact = unknown
TDiagnostic
TDiagnostic extends PipelineDiagnostic = PipelineDiagnostic
TRunResult
TRunResult = PipelineRunState<TArtifact, TDiagnostic>
TFragmentInput
TFragmentInput = unknown
TFragmentOutput
TFragmentOutput = unknown
TBuilderInput
TBuilderInput = unknown
TBuilderOutput
TBuilderOutput = unknown
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
createBuilderArgs()
readonly createBuilderArgs: (options) => HelperApplyOptions<TContext, TBuilderInput, TBuilderOutput, TReporter>;Parameters
options
artifact
TArtifact
buildOptions
TBuildOptions
context
TContext
helper
TBuilderHelper
options
TRunOptions
Returns
HelperApplyOptions<TContext, TBuilderInput, TBuilderOutput, TReporter>
createBuildOptions()
readonly createBuildOptions: (options) => TBuildOptions;Parameters
options
TRunOptions
Returns
TBuildOptions
createContext()
readonly createContext: (options) => TContext;Parameters
options
TRunOptions
Returns
TContext
createFragmentArgs()
readonly createFragmentArgs: (options) => HelperApplyOptions<TContext, TFragmentInput, TFragmentOutput, TReporter>;Parameters
options
buildOptions
TBuildOptions
context
TContext
draft
TDraft
helper
TFragmentHelper
options
TRunOptions
Returns
HelperApplyOptions<TContext, TFragmentInput, TFragmentOutput, TReporter>
createFragmentState()
readonly createFragmentState: (options) => TDraft;Parameters
options
buildOptions
TBuildOptions
context
TContext
options
TRunOptions
Returns
TDraft
finalizeFragmentState()
readonly finalizeFragmentState: (options) => TArtifact;Parameters
options
buildOptions
TBuildOptions
context
TContext
draft
TDraft
helpers
FragmentFinalizationMetadata<TFragmentKind>
options
TRunOptions
Returns
TArtifact
builderKind?
readonly optional builderKind: TBuilderKind;createConflictDiagnostic()?
readonly optional createConflictDiagnostic: (options) => TDiagnostic;Parameters
options
existing
TFragmentHelper | TBuilderHelper
helper
TFragmentHelper | TBuilderHelper
message
string
Returns
TDiagnostic
createError()?
readonly optional createError: (code, message) => Error;Parameters
code
string
message
string
Returns
Error
createExtensionHookOptions()?
readonly optional createExtensionHookOptions: (options) => PipelineExtensionHookOptions<TContext, TRunOptions, TArtifact>;Parameters
options
artifact
TArtifact
buildOptions
TBuildOptions
context
TContext
lifecycle
options
TRunOptions
Returns
PipelineExtensionHookOptions<TContext, TRunOptions, TArtifact>
createMissingDependencyDiagnostic()?
readonly optional createMissingDependencyDiagnostic: (options) => TDiagnostic;Parameters
options
dependency
string
helper
TFragmentHelper | TBuilderHelper
message
string
Returns
TDiagnostic
createRunResult()?
readonly optional createRunResult: (options) => TRunResult;Parameters
options
artifact
TArtifact
buildOptions
TBuildOptions
context
TContext
diagnostics
readonly TDiagnostic[]
helpers
PipelineExecutionMetadata<TFragmentKind, TBuilderKind>
options
TRunOptions
steps
readonly PipelineStep<HelperKind>[]
Returns
TRunResult
createUnusedHelperDiagnostic()?
readonly optional createUnusedHelperDiagnostic: (options) => TDiagnostic;Parameters
options
helper
TFragmentHelper | TBuilderHelper
message
string
Returns
TDiagnostic
fragmentKind?
readonly optional fragmentKind: TFragmentKind;onDiagnostic()?
readonly optional onDiagnostic: (options) => void;Optional hook invoked whenever a diagnostic is emitted during a run.
Consumers can stream diagnostics to logs or UI shells while the pipeline executes instead of waiting for the final run result.
Parameters
options
diagnostic
TDiagnostic
reporter
TReporter
Returns
void
onExtensionRollbackError()?
readonly optional onExtensionRollbackError: (options) => void;Parameters
options
context
TContext
error
unknown
errorMetadata
PipelineExtensionRollbackErrorMetadata
extensionKeys
readonly string[]
hookSequence
readonly string[]
Returns
void