@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.
36 lines (35 loc) • 1.14 kB
TypeScript
/**
* @module Semaphore
*/
import { type MiddlewareFn } from "../../../middleware/contracts/_module.js";
import { type ISemaphoreFactoryBase } from "../../../semaphore/contracts/_module.js";
import { type ITimeSpan } from "../../../time-span/contracts/time-span.contract.js";
import { type Invokable } from "../../../utilities/_module.js";
/**
* @group Middleware
*/
export type SemaphoreMiddlewareSettings<TParameters extends Array<unknown> = Array<unknown>> = {
/**
* @default
* ```ts
* (...args) => JSON.stringify(args)
* ```
*/
key?: Invokable<TParameters, string>;
/**
* @default
* ```ts
* import { v4 } from "uuid";
*
* () => v4()
* ```
*/
slotId?: Invokable<TParameters, string>;
ttl?: ITimeSpan | null;
limit: number;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/semaphore/middlewares"`
* @group Middleware
*/
export declare function semaphoreMiddlewareFactory(semaphoreFactory: ISemaphoreFactoryBase): <TParameters extends Array<unknown>, TReturn>(settings: SemaphoreMiddlewareSettings<TParameters>) => MiddlewareFn<TParameters, Promise<TReturn>>;