PipelineBuilder
Defined in: src/pipeline-builder.ts:55
The minimal builder: only the strategies you add end up in your bundle.
import { PipelineBuilder, retryStrategy, timeoutStrategy } from '@ylcnfrht/resilience';const pipeline = new PipelineBuilder().add(retryStrategy({ maxRetryAttempts: 3 })).add(timeoutStrategy('2s')).build();ResiliencePipelineBuilder adds Polly-style addRetry() / addTimeout() / … shortcuts on top, at the cost of
bundling every strategy. Strategies run in the order they are added: the first one added is the outermost.
Options are validated and strategy state (e.g. circuit breaker) is created on build().
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T = any
E = never
Caught
Section titled “Caught”Caught extends string = never
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PipelineBuilder<
T,E,Caught>(options?):PipelineBuilder<T,E,Caught>
Defined in: src/pipeline-builder.ts:62
Parameters
Section titled “Parameters”options?
Section titled “options?”ResiliencePipelineBuilderOptions = {}
Returns
Section titled “Returns”PipelineBuilder<T, E, Caught>
Properties
Section titled “Properties”
readonlyname:string|undefined
Defined in: src/pipeline-builder.ts:56
readonlytags:Readonly<Record<string,string>> |undefined
Defined in: src/pipeline-builder.ts:58
timeProvider
Section titled “timeProvider”
readonlytimeProvider:TimeProvider
Defined in: src/pipeline-builder.ts:57
Methods
Section titled “Methods”add<
D>(definition):PipelineBuilder<T,WithErrors<E,Caught,ErrorsOf<D>>,Caught|CatchesOf<D>>
Defined in: src/pipeline-builder.ts:69
Type Parameters
Section titled “Type Parameters”D extends StrategyDefinition<T, any>
Parameters
Section titled “Parameters”definition
Section titled “definition”D
Returns
Section titled “Returns”PipelineBuilder<T, WithErrors<E, Caught, ErrorsOf<D>>, Caught | CatchesOf<D>>
addPipeline()
Section titled “addPipeline()”addPipeline<
E2>(pipeline):PipelineBuilder<T,WithErrors<E,Caught,E2>,Caught>
Defined in: src/pipeline-builder.ts:81
Nest an existing pipeline (and its state) as a single strategy.
Type Parameters
Section titled “Type Parameters”E2
Parameters
Section titled “Parameters”pipeline
Section titled “pipeline”ResiliencePipeline<T, E2>
Returns
Section titled “Returns”PipelineBuilder<T, WithErrors<E, Caught, E2>, Caught>
addStrategy()
Section titled “addStrategy()”addStrategy(
create,name?):this
Defined in: src/pipeline-builder.ts:75
Plug in your own strategy.
Parameters
Section titled “Parameters”create
Section titled “create”string
Returns
Section titled “Returns”this
build()
Section titled “build()”build():
ResiliencePipeline<T,E>
Defined in: src/pipeline-builder.ts:85
Returns
Section titled “Returns”ResiliencePipeline<T, E>