@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.
107 lines (106 loc) • 4.64 kB
TypeScript
/**
* @module RateLimiter
*/
import { type IEventBus } from "../../../../event-bus/contracts/_module.js";
import { type Namespace } from "../../../../namespace/_module.js";
import { type IRateLimiterProviderFactory, type IRateLimiterProvider, type IRateLimiterAdapter } from "../../../../rate-limiter/contracts/_module.js";
import { type RateLimiterProviderSettingsBase } from "../../../../rate-limiter/implementations/derivables/rate-limiter-provider/_module.js";
import { type ErrorPolicy } from "../../../../utilities/_module.js";
/**
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export type RateLimiterAdapters<TAdapters extends string> = Partial<Record<TAdapters, IRateLimiterAdapter>>;
/**
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export type RateLimiterProviderFactorySettings<TAdapters extends string> = RateLimiterProviderSettingsBase & {
adapters: RateLimiterAdapters<TAdapters>;
defaultAdapter?: NoInfer<TAdapters>;
};
/**
* The `RateLimiterProviderFactory` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export declare class RateLimiterProviderFactory<TAdapters extends string> implements IRateLimiterProviderFactory<TAdapters> {
private readonly settings;
/**
* @example
* ```ts
* import { RateLimiterProviderFactory } 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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
* serde,
* adapters: {
* memory: new DatabaseRateLimiterAdapter({
* adapter: new MemoryRateLimiterStorageAdapter()
* }),
* redis: new RedisRateLimiterAdapter({
* database: new Redis("YOUR_REDIS_CONNECTION")
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: RateLimiterProviderFactorySettings<TAdapters>);
setNamespace(namespace: Namespace): RateLimiterProviderFactory<TAdapters>;
setEventBus(eventBus: IEventBus): RateLimiterProviderFactory<TAdapters>;
setOnlyError(onlyError?: boolean): RateLimiterProviderFactory<TAdapters>;
setErrorPolicy(errorPolicy: ErrorPolicy): RateLimiterProviderFactory<TAdapters>;
/**
* @example
* ```ts
* import { RateLimiterProviderFactory } 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 rateLimiterProviderFactory = new RateLimiterProviderFactory({
* 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 rateLimiterProviderFactory
* .use()
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
*
* // Will apply rate limiter logic the default adapter which is RedisRateLimiterAdapter
* await rateLimiterProviderFactory
* .use("redis")
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
* ```
*/
use(adapterName?: TAdapters | undefined): IRateLimiterProvider;
}