Definiert in: async-throttler.ts:74

Optionen zur Konfiguration einer asynchronen Drosselfunktion

• TFn erbt von AnyAsyncFunction

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

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

Definiert in: async-throttler.ts:80

Ob der Throttler aktiviert ist. Wenn deaktiviert, löst maybeExecute keine Ausführungen aus. Kann ein Boolean oder eine Funktion sein, die einen Boolean zurückgibt. Standardmäßig true.

optional initialState: Partial<AsyncThrottlerState<TFn>>;

optional initialState: Partial<AsyncThrottlerState<TFn>>;

Definiert in: async-throttler.ts:84

Anfangszustand für den asynchronen Throttler

optional key: string;

optional key: string;

Definiert in: async-throttler.ts:89

Optionaler Schlüssel zur Identifizierung dieser asynchronen Throttler-Instanz. Wenn angegeben, wird der asynchrone Throttler durch diesen Schlüssel in den Devtools und PacerProvider identifiziert, falls zutreffend.

optional leading: boolean;

optional leading: boolean;

Definiert in: async-throttler.ts:94

Ob die Funktion sofort ausgeführt werden soll, wenn sie aufgerufen wird. Standardmäßig true.

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

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

Definiert in: async-throttler.ts:100

Optionaler Fehlerbehandler für den Fall, dass die gedrosselte Funktion einen Fehler auslöst. Wenn angegeben, wird der Handler mit dem Fehler und der Throttler-Instanz aufgerufen. Dies kann zusammen mit throwOnError verwendet werden - der Handler wird aufgerufen, bevor ein Fehler ausgelöst wird.

unbekannt

Parameter<TFn>

AsyncThrottler<TFn>

void

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

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

Definiert in: async-throttler.ts:108

Optionale Funktion, die aufgerufen wird, wenn die gedrosselte Funktion ausgeführt wird

Parameter<TFn>

AsyncThrottler<TFn>

void

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

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

Definiert in: async-throttler.ts:115

Optionale Funktion, die aufgerufen wird, wenn die gedrosselte Funktion ausgeführt wird

Rückgabetyp<TFn>

Parameter<TFn>

AsyncThrottler<TFn>

void

optional throwOnError: boolean;

optional throwOnError: boolean;

Definiert in: async-throttler.ts:125

Ob Fehler ausgelöst werden sollen, wenn sie auftreten. Standardmäßig true, wenn kein onError-Handler bereitgestellt wird, false, wenn ein onError-Handler bereitgestellt wird. Kann explizit gesetzt werden, um diese Standardwerte zu überschreiben.

optional trailing: boolean;

optional trailing: boolean;

Definiert in: async-throttler.ts:130

Ob die Funktion am Ende des Wartezeitraums ausgeführt werden soll. Standardmäßig true.

wait: number | (throttler) => number;

wait: number | (throttler) => number;

Definiert in: async-throttler.ts:136

Zeitfenster in Millisekunden, in dem die Funktion nur einmal ausgeführt werden kann. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt. Standardmäßig 0 ms.