Definiert in: async-batcher.ts:82

Optionen zur Konfiguration einer AsyncBatcher-Instanz

• TValue

optional getShouldExecute: (items, batcher) => boolean;

optional getShouldExecute: (items, batcher) => boolean;

Definiert in: async-batcher.ts:87

Benutzerdefinierte Funktion zur Bestimmung, ob ein Batch verarbeitet werden soll. Geben Sie true zurück, um den Batch sofort zu verarbeiten.

TValue[]

AsyncBatcher<TValue>

boolean

optional initialState: Partial<AsyncBatcherState<TValue>>;

optional initialState: Partial<AsyncBatcherState<TValue>>;

Definiert in: async-batcher.ts:94

Anfangszustand für den asynchronen Batcher.

optional key: string;

optional key: string;

Definiert in: async-batcher.ts:99

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

optional maxSize: number;

optional maxSize: number;

Definiert in: async-batcher.ts:104

Maximale Anzahl von Elementen in einem Batch.

Infinity

Infinity

optional onError: (error, batch, batcher) => void;

optional onError: (error, batch, batcher) => void;

Definiert in: async-batcher.ts:110

Optionaler Fehlerhandler, wenn die Batch-Funktion einen Fehler auslöst. Wenn angegeben, wird der Handler mit dem Fehler, dem fehlerhaften Batch von Elementen und der Batcher-Instanz aufgerufen. Dies kann zusammen mit throwOnError verwendet werden - der Handler wird aufgerufen, bevor ein Fehler ausgelöst wird.

unbekannt

TValue[]

AsyncBatcher<TValue>

void

optional onItemsChange: (batcher) => void;

optional onItemsChange: (batcher) => void;

Definiert in: async-batcher.ts:118

Callback, der aufgerufen wird, nachdem Elemente zum Batcher hinzugefügt wurden.

AsyncBatcher<TValue>

void

optional onSettled: (batch, batcher) => void;

optional onSettled: (batch, batcher) => void;

Definiert in: async-batcher.ts:122

Optionaler Callback, der aufgerufen wird, wenn ein Batch abgeschlossen ist (erfolgreich oder fehlgeschlagen).

TValue[]

AsyncBatcher<TValue>

void

optional onSuccess: (result, batch, batcher) => void;

optional onSuccess: (result, batch, batcher) => void;

Definiert in: async-batcher.ts:126

Optionaler Callback, der aufgerufen wird, wenn ein Batch erfolgreich ist.

any

TValue[]

AsyncBatcher<TValue>

void

optional started: boolean;

optional started: boolean;

Definiert in: async-batcher.ts:135

Ob der Batcher sofort mit der Verarbeitung beginnen soll.

true

true

optional throwOnError: boolean;

optional throwOnError: boolean;

Definiert in: async-batcher.ts:141

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 wait: number | (asyncBatcher) => number;

optional wait: number | (asyncBatcher) => number;

Definiert in: async-batcher.ts:148

Maximale Wartezeit in Millisekunden, bevor ein Batch verarbeitet wird. Wenn die Wartezeit abgelaufen ist, wird der Batch verarbeitet. Wenn nicht angegeben, wird der Batch nicht durch ein Timeout ausgelöst.

Infinity

Infinity