Class DatabaseRateLimiterProviderFactory<TAdapters>

The DatabaseRateLimiterProviderFactory class is immutable.

IMPORT_PATH: "@daiso-tech/core/rate-limiter"

Type Parameters

  • TAdapters extends string

Implements

Constructors

constructor

Methods

setBackoffPolicy setErrorPolicy setEventBus setNamespace setOnlyError setRateLimiterPolicy use

Constructors

constructor

Methods

setBackoffPolicy

setErrorPolicy

setEventBus

setNamespace

setOnlyError

setRateLimiterPolicy

use

  • use(adapterName?: undefined | TAdapters): IRateLimiterProvider

  • Parameters

    Returns IRateLimiterProvider

    Example

    import { RateLimiterProviderFactory } from "@daiso-tech/core/rate-limiter";
    import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
    import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
    import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-adapter";
    import { Serde } from "@daiso-tech/core/serde";
    import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
    import Sqlite from "better-sqlite3";
    import { Kysely, SqliteDialect } from "kysely";

    const serde = new Serde(new SuperJsonSerdeAdapter());
    const rateLimiterProviderFactory = new RateLimiterProviderFactory({
      serde,
      adapters: {
        memory: new MemoryRateLimiterStorageAdapter(),
        sqlite: new KyselyRateLimiterStorageAdapter({
          kysely: new Kysely({
            dialect: new SqliteDialect({
              database: new Sqlite("local.db"),
            }),
          }),
          serde,
        }),
      },
      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 KyselyRateLimiterStorageAdapter
    await rateLimiterProviderFactory
      .use("sqlite")
      .create("a")
      .runOrFail(async () => {
        // ... code to apply rate limiter logic
      });

Settings

Member Visibility

On This Page

Constructors
Methods