Definiert in: rate-limiter.ts:47

Optionen zur Konfiguration einer ratenbegrenzten Funktion

• TFn erweitert AnyFunction

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

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

Definiert in: rate-limiter.ts:52

Ob der Ratenbegrenzer aktiviert ist. Wenn deaktiviert, wird maybeExecute keine Ausführungen auslösen. Standardwert ist true.

optional initialState: Partial<RateLimiterState>;

optional initialState: Partial<RateLimiterState>;

Definiert in: rate-limiter.ts:56

Anfangszustand für den Ratenbegrenzer

optional key: string;

optional key: string;

Definiert in: rate-limiter.ts:61

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

limit: number | (rateLimiter) => number;

limit: number | (rateLimiter) => number;

Definiert in: rate-limiter.ts:66

Maximale Anzahl von Ausführungen, die innerhalb des Zeitfensters zulässig sind. Kann eine Zahl oder eine Callback-Funktion sein, die die Ratenbegrenzer-Instanz empfängt und eine Zahl zurückgibt.

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

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

Definiert in: rate-limiter.ts:70

Callback-Funktion, die nach Ausführung der Funktion aufgerufen wird

Parameter<TFn>

RateLimiter<TFn>

void

optional onReject: (rateLimiter) => void;

optional onReject: (rateLimiter) => void;

Definiert in: rate-limiter.ts:74

Optionale Callback-Funktion, die aufgerufen wird, wenn eine Ausführung aufgrund von Ratenbegrenzung abgelehnt wird

RateLimiter<TFn>

void

window: number | (rateLimiter) => number;

window: number | (rateLimiter) => number;

Definiert in: rate-limiter.ts:79

Zeitfenster in Millisekunden, innerhalb dessen das Limit gilt. Kann eine Zahl oder eine Callback-Funktion sein, die die Ratenbegrenzer-Instanz empfängt und eine Zahl zurückgibt.

optional windowType: "fixed" | "sliding";

optional windowType: "fixed" | "sliding";

Definiert in: rate-limiter.ts:86

Art des Fensters, das für die Ratenbegrenzung verwendet werden soll

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