@daiso-tech/core/dist/rate-limiter/implementations/derivables/rate-limiter-factory-resolver/rate-limiter-factory-resolver.js

The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.

/**
 * @module RateLimiter
 */
import {} from "../../../../event-bus/contracts/_module.js";
import {} from "../../../../execution-context/contracts/_module.js";
import {} from "../../../../namespace/contracts/_module.js";
import {} from "../../../../rate-limiter/contracts/_module.js";
import { RateLimiterFactory, } from "../../../../rate-limiter/implementations/derivables/rate-limiter-factory/_module.js";
import { 
// eslint-disable-next-line @typescript-eslint/no-unused-vars
UnregisteredAdapterError, 
// eslint-disable-next-line @typescript-eslint/no-unused-vars
DefaultAdapterNotDefinedError, } from "../../../../utilities/_module.js";
/**
 * The `RateLimiterFactoryResolver` class is immutable.
 *
 * IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
 * @group Derivables
 */
export class RateLimiterFactoryResolver {
    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) {
        this.settings = settings;
    }
    setNamespace(namespace) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            namespace,
        });
    }
    setEventBus(eventBus) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            eventBus,
        });
    }
    setOnlyError(onlyError) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            onlyError,
        });
    }
    setDefaultErrorPolicy(errorPolicy) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            defaultErrorPolicy: errorPolicy,
        });
    }
    setWaitUntil(waitUntil) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            waitUntil,
        });
    }
    setExecutionContext(executionContext) {
        return new RateLimiterFactoryResolver({
            ...this.settings,
            executionContext,
        });
    }
    /**
     * @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 = this.settings.defaultAdapter) {
        if (adapterName === undefined) {
            throw new DefaultAdapterNotDefinedError(RateLimiterFactoryResolver.name);
        }
        const adapter = this.settings.adapters[adapterName];
        if (adapter === undefined) {
            throw new UnregisteredAdapterError(adapterName);
        }
        return new RateLimiterFactory({
            ...this.settings,
            adapter,
        });
    }
}
//# sourceMappingURL=rate-limiter-factory-resolver.js.map