Definiert in: async-rate-limiter.ts:69

Optionen zur Konfiguration einer asynchronen Ratenbegrenzungsfunktion

• TFn erbt von AnyAsyncFunction

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

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

Definiert in: async-rate-limiter.ts:75

Ob der Ratenbegrenzer aktiviert ist. Wenn deaktiviert, löst maybeExecute keine Ausführungen aus. Kann ein boolescher Wert oder eine Funktion sein, die einen booleschen Wert zurückgibt. Standardwert ist true.

optional initialState: Partial<AsyncRateLimiterState<TFn>>;

optional initialState: Partial<AsyncRateLimiterState<TFn>>;

Definiert in: async-rate-limiter.ts:79

Anfangszustand für den Ratenbegrenzer

optional key: string;

optional key: string;

Definiert in: async-rate-limiter.ts:84

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

limit: number | (rateLimiter) => number;

limit: number | (rateLimiter) => number;

Definiert in: async-rate-limiter.ts:89

Maximale Anzahl von Ausführungen, die innerhalb des Zeitfensters erlaubt sind. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt.

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

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

Definiert in: async-rate-limiter.ts:95

Optionaler Fehlerbehandlungsmechanismus, wenn die ratenbegrenzte Funktion einen Fehler wirft. Wenn angegeben, wird der Behandlungsmechanismus mit dem Fehler und der Ratenbegrenzerinstanz aufgerufen. Dies kann zusammen mit throwOnError verwendet werden - der Behandlungsmechanismus wird aufgerufen, bevor ein Fehler ausgelöst wird.

unbekannt

Parameter<TFn>

AsyncRateLimiter<TFn>

void

optional onReject: (args, rateLimiter) => void;

optional onReject: (args, rateLimiter) => void;

Definiert in: async-rate-limiter.ts:103

Optionaler Callback, der aufgerufen wird, wenn eine Ausführung aufgrund von Ratenbegrenzungen abgelehnt wird

Parameter<TFn>

AsyncRateLimiter<TFn>

void

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

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

Definiert in: async-rate-limiter.ts:107

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

Parameter<TFn>

AsyncRateLimiter<TFn>

void

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

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

Definiert in: async-rate-limiter.ts:114

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

Rückgabetyp<TFn>

Parameter<TFn>

AsyncRateLimiter<TFn>

void

optional throwOnError: boolean;

optional throwOnError: boolean;

Definiert in: async-rate-limiter.ts:124

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.

window: number | (rateLimiter) => number;

window: number | (rateLimiter) => number;

Definiert in: async-rate-limiter.ts:129

Zeitfenster in Millisekunden, innerhalb dessen das Limit gilt. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt.

optional windowType: "fixed" | "sliding";

optional windowType: "fixed" | "sliding";

Definiert in: async-rate-limiter.ts:136

Art des Fensters, das für die Ratenbegrenzung verwendet wird

• 'fixed': Verwendet ein festes Fenster, das nach Ablauf des Fensterzeitraums zurückgesetzt wird
• 'sliding': Verwendet ein gleitendes Fenster, das Ausführungen zulässt, wenn alte abgelaufen sind. Standardwert ist 'fixed'.