/** * @module RateLimiter */ import { type IReadableContext } from "../../../../execution-context/contracts/_module.js"; import { type IRateLimiterFactoryResolver, type IRateLimiterFactory, type IRateLimiterAdapter } from "../../../../rate-limiter/contracts/_module.js"; import { type RateLimiterFactorySettingsBase } from "../../../../rate-limiter/implementations/derivables/rate-limiter-factory/_module.js"; import { type ErrorPolicy, type WaitUntil } from "../../../../utilities/_module.js"; /** * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"` * @group Derivables */ export type RateLimiterAdapters = Partial>; /** * Configuration for `RateLimiterFactoryResolver`. * Registers named rate-limiter adapters and optionally designates a default. * * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"` * @group Derivables */ export type RateLimiterFactoryResolverSettings = RateLimiterFactorySettingsBase & { /** * Named registry of rate-limiter adapters. Each key is an adapter alias and the corresponding value is the adapter instance. */ adapters: RateLimiterAdapters; /** * The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map. */ defaultAdapter?: NoInfer; }; /** * The `RateLimiterFactoryResolver` class is immutable. * * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"` * @group Derivables */ export declare class RateLimiterFactoryResolver implements IRateLimiterFactoryResolver { private readonly settings; /** * @example * ```ts * import { RateLimiterFactoryResolver } from "@daiso-tech/core/rate-limiter"; * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter"; * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter"; * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-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 rateLimiterFactoryResolver = new RateLimiterFactoryResolver({ * serde, * adapters: { * memory: new DatabaseRateLimiterAdapter({ * adapter: new MemoryRateLimiterStorageAdapter() * }), * redis: new RedisRateLimiterAdapter({ * database: new Redis("YOUR_REDIS_CONNECTION") * }), * }, * defaultAdapter: "memory", * }); * ``` */ constructor(settings: RateLimiterFactoryResolverSettings); setOnlyError(onlyError?: boolean): RateLimiterFactoryResolver; setDefaultErrorPolicy(errorPolicy: ErrorPolicy): RateLimiterFactoryResolver; setWaitUntil(waitUntil: WaitUntil): RateLimiterFactoryResolver; setExecutionContext(context: IReadableContext): RateLimiterFactoryResolver; /** * @example * ```ts * import { RateLimiterFactoryResolver } from "@daiso-tech/core/rate-limiter"; * import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter"; * import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter"; * import { RedisRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/redis-rate-limiter-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 rateLimiterFactoryResolver = new RateLimiterFactoryResolver({ * serde, * adapters: { * memory: new DatabaseRateLimiterAdapter({ * adapter: new MemoryRateLimiterStorageAdapter() * }), * redis: new RedisRateLimiterAdapter({ * database: new Redis("YOUR_REDIS_CONNECTION") * }), * }, * defaultAdapter: "memory", * }); * * // Will apply rate limiter logic the default adapter which is MemoryRateLimiterStorageAdapter * await rateLimiterFactoryResolver * .use() * .create("a") * .runOrFail(async () => { * // ... code to apply rate limiter logic * }); * * // Will apply rate limiter logic the default adapter which is RedisRateLimiterAdapter * await rateLimiterFactoryResolver * .use("redis") * .create("a") * .runOrFail(async () => { * // ... code to apply rate limiter logic * }); * ``` */ use(adapterName?: TAdapters | undefined): IRateLimiterFactory; }