ResiliencePipelineRegistry
Defined in: src/registry.ts:46
Builds each keyed pipeline once and caches it, so stateful strategies (circuit breakers, limiters) are shared.
Type Parameters
Section titled “Type Parameters”K = string
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ResiliencePipelineRegistry<
K>(options?):ResiliencePipelineRegistry<K>
Defined in: src/registry.ts:54
Parameters
Section titled “Parameters”options?
Section titled “options?”pipelineName?
Section titled “pipelineName?”(key) => string
timeProvider?
Section titled “timeProvider?”Returns
Section titled “Returns”ResiliencePipelineRegistry<K>
Methods
Section titled “Methods”circuitBreakers()
Section titled “circuitBreakers()”circuitBreakers():
RegisteredStrategy<K>[]
Defined in: src/registry.ts:103
Every circuit breaker in the registry’s pipelines, e.g. for a health endpoint: strategy.state, strategy.metrics.
Returns
Section titled “Returns”RegisteredStrategy<K>[]
dispose()
Section titled “dispose()”dispose():
void
Defined in: src/registry.ts:113
Dispose every pipeline (background timers, store sync). The registry can’t be used afterwards.
Returns
Section titled “Returns”void
getOrAddPipeline()
Section titled “getOrAddPipeline()”getOrAddPipeline<
T>(key,configure):ResiliencePipeline<T>
Defined in: src/registry.ts:79
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”K
configure
Section titled “configure”Returns
Section titled “Returns”getPipeline()
Section titled “getPipeline()”getPipeline<
T>(key):ResiliencePipeline<T>
Defined in: src/registry.ts:73
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”keys()
Section titled “keys()”keys():
K[]
Defined in: src/registry.ts:98
Keys of the pipelines built so far.
Returns
Section titled “Returns”K[]
limiters()
Section titled “limiters()”limiters():
RegisteredStrategy<K>[]
Defined in: src/registry.ts:108
Every concurrency / rate limiter, e.g. to report active / queued / limit.
Returns
Section titled “Returns”RegisteredStrategy<K>[]
reload()
Section titled “reload()”reload(
key,configure?):void
Defined in: src/registry.ts:87
Rebuild key’s pipeline, optionally with a new configuration (e.g. limits from a feature flag).
Existing references keep working and pick up the new pipeline; the old one is disposed and its state dropped.
Parameters
Section titled “Parameters”K
configure?
Section titled “configure?”Returns
Section titled “Returns”void
tryAddBuilder()
Section titled “tryAddBuilder()”tryAddBuilder(
key,configure):boolean
Defined in: src/registry.ts:60
Registers how to build key; returns false if a builder is already registered.
Parameters
Section titled “Parameters”K
configure
Section titled “configure”Returns
Section titled “Returns”boolean
tryGetPipeline()
Section titled “tryGetPipeline()”tryGetPipeline<
T>(key):ResiliencePipeline<T,any> |undefined
Defined in: src/registry.ts:66
Type Parameters
Section titled “Type Parameters”T = any
Parameters
Section titled “Parameters”K
Returns
Section titled “Returns”ResiliencePipeline<T, any> | undefined