AsyncThrottlerOptions

Defined in: async-throttler.ts:76

Options for configuring an async throttled function

Type Parameters#

TFn#

TFn extends AnyAsyncFunction

Properties#

asyncRetryerOptions?#

optional asyncRetryerOptions?: AsyncRetryerOptions<TFn>;

Defined in: async-throttler.ts:80

Options for configuring the underlying async retryer

enabled?#

optional enabled?: boolean | ((throttler) => boolean);

Defined in: async-throttler.ts:86

Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. Defaults to true.

initialState?#

optional initialState?: Partial<AsyncThrottlerState<TFn>>;

Defined in: async-throttler.ts:90

Initial state for the async throttler

key?#

optional key?: string;

Defined in: async-throttler.ts:95

Optional key to identify this async throttler instance. If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable.

leading?#

optional leading?: boolean;

Defined in: async-throttler.ts:100

Whether to execute the function immediately when called Defaults to true

onError?#

optional onError?: (error, args, asyncThrottler) => void;

Defined in: async-throttler.ts:106

Optional error handler for when the throttled function throws. If provided, the handler will be called with the error and throttler instance. This can be used alongside throwOnError - the handler will be called before any error is thrown.

Parameters#

error#

Error

args#

Parameters<TFn>

asyncThrottler#

AsyncThrottler<TFn>

Returns#

void

onSettled?#

optional onSettled?: (args, asyncThrottler) => void;

Defined in: async-throttler.ts:114

Optional function to call when the throttled function is executed

Parameters#

args#

Parameters<TFn>

asyncThrottler#

AsyncThrottler<TFn>

Returns#

void

onSuccess?#

optional onSuccess?: (result, args, asyncThrottler) => void;

Defined in: async-throttler.ts:121

Optional function to call when the throttled function is executed

Parameters#

result#

Awaited<ReturnType<TFn>>

args#

Parameters<TFn>

asyncThrottler#

AsyncThrottler<TFn>

Returns#

void

throwOnError?#

optional throwOnError?: boolean;

Defined in: async-throttler.ts:131

Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. Can be explicitly set to override these defaults.

trailing?#

optional trailing?: boolean;

Defined in: async-throttler.ts:136

Whether to execute the function on the trailing edge of the wait period Defaults to true

wait#

wait: number | ((throttler) => number);

Defined in: async-throttler.ts:142

Time window in milliseconds during which the function can only be executed once. Can be a number or a function that returns a number. Defaults to 0ms