Type Alias RateLimiterProviderSettingsBase

RateLimiterProviderSettingsBase: {
    defaultErrorPolicy?: ErrorPolicy;
    enableAsyncTracking?: boolean;
    eventBus?: IEventBus;
    namespace?: INamespace;
    onlyError?: boolean;
    serde?: OneOrMore<ISerderRegister>;
    serdeTransformerName?: string;
}

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

Type declaration

  • OptionaldefaultErrorPolicy?: ErrorPolicy

    You can set the default ErrorPolicy

    Default

    (_error: unknown) => true
  • OptionalenableAsyncTracking?: boolean

    If true, metric tracking will run asynchronously in the background and won't block the function utilizing the circuit breaker logic. This will only have effect if onlyError settings is true.

    Default

    true
  • OptionaleventBus?: IEventBus

    Default

    import { EventBus } from "@daiso-tech/core/event-bus";
    import { NoOpEventBusAdapter } from "@daiso-tech/core/event-bus/no-op-event-bus-adapter";

    new EventBus({
      adapter: new NoOpEventBusAdapter()
    })
  • Optionalnamespace?: INamespace

    Default

    import { Namespace } from "@daiso-tech/core/namespace";

    new Namespace("@rate-limiter")
  • OptionalonlyError?: boolean

    If true will only apply rate limiting when function errors and not when function is called.

    Default

    false
  • Optionalserde?: OneOrMore<ISerderRegister>

    Default

    import { Serde } from "@daiso-tech/serde";
    import { NoOpSerdeAdapter } from "@daiso-tech/serde/no-op-serde-adapter";

    new Serde(new NoOpSerdeAdapter())
  • OptionalserdeTransformerName?: string

    Default

    ""

Settings

Member Visibility