Type Alias RateLimiterFactoryCreateSettings

RateLimiterFactoryCreateSettings: ErrorPolicySettings & {
    limit: number;
    onlyError?: boolean;
}

Configuration settings for creating a rate limiter instance through the factory.

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

Type declaration

  • limit: number

    Maximum number of allowed function invocations within the configured rate-limiter policy window. Once this limit is reached, further invocations will be blocked (BlockedRateLimiterError) until the policy permits attempts again.

  • OptionalonlyError?: boolean

    If true, the rate limiter will only count function invocations that result in errors. Successful executions will not consume from the rate limit quota. If false, all invocations (successful or failed) are counted against the limit.

Settings

Member Visibility