Definiert in: throttler.ts:54

Optionen zur Konfiguration einer gedrosselten Funktion

• TFn erweitert AnyFunction

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

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

Definiert in: throttler.ts:60

Ob der Throttler aktiviert ist. Wenn deaktiviert, wird maybeExecute keine Ausführungen auslösen. Kann ein boolescher Wert oder eine Funktion sein, die einen booleschen Wert zurückgibt. Standardwert ist true.

optional initialState: Partial<ThrottlerState<TFn>>;

optional initialState: Partial<ThrottlerState<TFn>>;

Definiert in: throttler.ts:64

Anfangszustand für den Throttler

optional key: string;

optional key: string;

Definiert in: throttler.ts:69

Ein Schlüssel zur Identifizierung des Throttlers. Wenn angegeben, wird der Throttler anhand dieses Schlüssels in den Devtools und PacerProvider identifiziert, sofern zutreffend.

optional leading: boolean;

optional leading: boolean;

Definiert in: throttler.ts:74

Ob auf der führenden Kante des Timeouts ausgeführt werden soll. Standardwert ist true.

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

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

Definiert in: throttler.ts:78

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

Parameter<TFn>

Throttler<TFn>

void

optional trailing: boolean;

optional trailing: boolean;

Definiert in: throttler.ts:83

Ob die Ausführung am abschließenden Rand des Timeouts erfolgen soll. Standardmäßig true.

wait: number | (throttler) => number;

wait: number | (throttler) => number;

Definiert in: throttler.ts:89

Zeitfenster in Millisekunden, während dessen die Funktion nur einmal ausgeführt werden kann. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt. Standardwert ist 0 ms.