@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.
27 lines (26 loc) • 1.1 kB
TypeScript
/**
* @module RateLimiter
*/
import { type CircuitBreakerTrigger, type ICircuitBreakerFactoryBase } from "../../../circuit-breaker/contracts/_module.js";
import { type MiddlewareFn } from "../../../middleware/contracts/_module.js";
import { type ITimeSpan } from "../../../time-span/contracts/_module.js";
import { type ErrorPolicy, type Invokable } from "../../../utilities/_module.js";
/**
* @group Middleware
*/
export type CircuitBreakerMiddlewareSettings<TParameters extends Array<unknown> = Array<unknown>> = ErrorPolicy & {
/**
* @default
* ```ts
* (...args) => JSON.stringify(args)
* ```
*/
key?: Invokable<TParameters, string>;
trigger?: CircuitBreakerTrigger;
slowCallTime?: ITimeSpan;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/middlewares"`
* @group Middleware
*/
export declare function circuitBreakerMiddlewareFactory(circuitBreakerFactory: ICircuitBreakerFactoryBase): <TParameters extends Array<unknown>, TReturn>(settings: CircuitBreakerMiddlewareSettings<TParameters>) => MiddlewareFn<TParameters, Promise<TReturn>>;