Type Alias KyselyRateLimiterStorageAdapterSettings

KyselyRateLimiterStorageAdapterSettings: {
    enableTransactions?: boolean;
    expiredKeysRemovalInterval?: ITimeSpan;
    kysely: Kysely<KyselyRateLimiterStorageTables>;
    serde: ISerde<string>;
    shouldRemoveExpiredKeys?: boolean;
}

Configuration for KyselyRateLimiterStorageAdapter. Requires a Kysely database instance with the rate-limiter schema applied.

IMPORT_PATH: "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"

Type declaration

  • OptionalenableTransactions?: boolean

    Default

    import { Transaction } from "kysely"

    !(settings.kysely instanceof Transaction)
  • OptionalexpiredKeysRemovalInterval?: ITimeSpan

    Default

    import { TimeSpan } from "@daiso-tech/core/time-span";

    TimeSpan.fromMinutes(1)
  • kysely: Kysely<KyselyRateLimiterStorageTables>

    The Kysely database instance with the required rate-limiter schema tables applied.

  • serde: ISerde<string>

    Serde instance for serializing and deserializing rate-limiter state to and from strings.

  • OptionalshouldRemoveExpiredKeys?: boolean

    When true, a background task periodically removes expired rate-limiter records. Set to false to disable automatic cleanup.

    Default

    true

Settings

Member Visibility