@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
109 lines (108 loc) • 5.05 kB
TypeScript
/**
* @module CircuitBreaker
*/
import { type ICircuitBreakerProviderFactory, type CircuitBreakerTrigger, type ICircuitBreakerProvider, type ICircuitBreakerAdapter } from "../../../../circuit-breaker/contracts/_module.js";
import { type CircuitBreakerProviderSettingsBase } from "../../../../circuit-breaker/implementations/derivables/circuit-breaker-provider/_module.js";
import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
import { type Namespace } from "../../../../namespace/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type ErrorPolicy } from "../../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export type CircuitBreakerAdapters<TAdapters extends string> = Partial<Record<TAdapters, ICircuitBreakerAdapter>>;
/**
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export type CircuitBreakerProviderFactorySettings<TAdapters extends string> = CircuitBreakerProviderSettingsBase & {
adapters: CircuitBreakerAdapters<TAdapters>;
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `CircuitBreakerProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
* @group Derivables
*/
export declare class CircuitBreakerProviderFactory<TAdapters extends string> implements ICircuitBreakerProviderFactory<TAdapters> {
private readonly settings;
/**
* @example
* ```ts
* import { CircuitBreakerProviderFactory } from "@daiso-tech/core/circuit-breaker";
* import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
* import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-adapter";
* import { RedisCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/redis-circuit-breaker-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import Redis from "ioredis"
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const circuitBreakerProviderFactory = new CircuitBreakerProviderFactory({
* serde,
* adapters: {
* memory: new DatabaseCircuitBreakerAdapter({
* adapter: new MemoryCircuitBreakerStorageAdapter()
* }),
* redis: new RedisCircuitBreakerAdapter({
* database: new Redis("YOUR_REDIS_CONNECTION")
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: CircuitBreakerProviderFactorySettings<TAdapters>);
setNamespace(namespace: Namespace): CircuitBreakerProviderFactory<TAdapters>;
setEventBus(eventBus: IEventBus): CircuitBreakerProviderFactory<TAdapters>;
setDefaultSlowCallTime(slowCallTime?: ITimeSpan): CircuitBreakerProviderFactory<TAdapters>;
setDefaultTrigger(trigger?: CircuitBreakerTrigger): CircuitBreakerProviderFactory<TAdapters>;
setDefaultErrorPolicy(defaultErrorPolicy: ErrorPolicy): CircuitBreakerProviderFactory<TAdapters>;
/**
* @example
* ```ts
* import { CircuitBreakerProviderFactory } from "@daiso-tech/core/circuit-breaker";
* import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
* import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-adapter";
* import { RedisCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/redis-circuit-breaker-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
* import Redis from "ioredis"
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const circuitBreakerProviderFactory = new CircuitBreakerProviderFactory({
* serde,
* adapters: {
* memory: new DatabaseCircuitBreakerAdapter({
* adapter: new MemoryCircuitBreakerStorageAdapter()
* }),
* redis: new RedisCircuitBreakerAdapter({
* database: new Redis("YOUR_REDIS_CONNECTION")
* }),
* },
* defaultAdapter: "memory",
* });
*
* // Will apply circuit breaker logic the default adapter which is MemoryCircuitBreakerStorageAdapter
* await circuitBreakerProviderFactory
* .use()
* .create("a")
* .runOrFail(async () => {
* // ... code to apply circuit breaker logic
* });
*
* // Will apply circuit breaker logic using the RedisCircuitBreakerAdapter
* await circuitBreakerProviderFactory
* .use("redis")
* .create("a")
* .runOrFail(async () => {
* // ... code to apply circuit breaker logic
* });
* ```
*/
use(adapterName?: TAdapters | undefined): ICircuitBreakerProvider;
}