Framework
Version
Debouncer API Referenz
Throttler API Referenz
Rate Limiter API Referenz
Queue API Referenz
Batcher API Referenz

AsyncQueuerOptions

Interface: AsyncQueuerOptions<TValue>

Definiert in: async-queuer.ts:100

Typparameter

TValue

Eigenschaften

addItemsTo?

ts
optional addItemsTo: QueuePosition;
optional addItemsTo: QueuePosition;

Definiert in: async-queuer.ts:105

Standardposition, um Elemente dem Queuer hinzuzufügen

Standard

ts
'back'
'back'

concurrency?

ts
optional concurrency: number | (queuer) => number;
optional concurrency: number | (queuer) => number;

Definiert in: async-queuer.ts:111

Maximale Anzahl gleichzeitiger Aufgaben, die verarbeitet werden sollen. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt.

Standard

ts
1
1

expirationDuration?

ts
optional expirationDuration: number;
optional expirationDuration: number;

Definiert in: async-queuer.ts:116

Maximale Zeit in Millisekunden, die ein Element in der Warteschlange verbleiben kann. Wenn nicht angegeben, laufen Elemente niemals ab.


getIsExpired()?

ts
optional getIsExpired: (item, addedAt) => boolean;
optional getIsExpired: (item, addedAt) => boolean;

Definiert in: async-queuer.ts:121

Funktion zur Bestimmung, ob ein Element abgelaufen ist. Wenn angegeben, überschreibt dies das Verhalten von expirationDuration.

Parameter

item

TValue

addedAt

number

Gibt zurück

boolean


getItemsFrom?

ts
optional getItemsFrom: QueuePosition;
optional getItemsFrom: QueuePosition;

Definiert in: async-queuer.ts:126

Standardposition, von der Elemente während der Verarbeitung abgerufen werden sollen

Standard

ts
'front'
'front'

getPriority()?

ts
optional getPriority: (item) => number;
optional getPriority: (item) => number;

Definiert in: async-queuer.ts:132

Funktion zur Bestimmung der Priorität von Elementen im Queuer. Elemente mit höherer Priorität werden zuerst verarbeitet. Wenn nicht angegeben, werden statische Prioritätswerte verwendet, die an Aufgaben angehängt sind.

Parameter

item

TValue

Gibt zurück

number


initialItems?

ts
optional initialItems: TValue[];
optional initialItems: TValue[];

Definiert in: async-queuer.ts:136

Anfangselemente, um den Queuer zu füllen


initialState?

ts
optional initialState: Partial<AsyncQueuerState<TValue>>;
optional initialState: Partial<AsyncQueuerState<TValue>>;

Definiert in: async-queuer.ts:140

Anfangszustand für den asynchronen Queuer


key?

ts
optional key: string;
optional key: string;

Definiert in: async-queuer.ts:145

Optionaler Schlüssel zur Identifizierung dieser asynchronen Queuer-Instanz. Wenn angegeben, wird der asynchrone Queuer anhand dieses Schlüssels in den DevTools und im PacerProvider, falls zutreffend, identifiziert.


maxSize?

ts
optional maxSize: number;
optional maxSize: number;

Definiert in: async-queuer.ts:149

Maximale Anzahl von Elementen, die im Queuer zugelassen sind


onError()?

ts
optional onError: (error, item, queuer) => void;
optional onError: (error, item, queuer) => void;

Definiert in: async-queuer.ts:155

Optionaler Fehlerbehandlungsmechanismus für den Fall, dass eine Aufgabe einen Fehler auslöst. Wenn angegeben, wird der Handler mit dem Fehler und der Queuer-Instanz aufgerufen. Dies kann zusammen mit throwOnError verwendet werden – der Handler wird aufgerufen, bevor ein Fehler ausgelöst wird.

Parameter

error

unbekannt

item

TValue

queuer

AsyncQueuer<TValue>

Gibt zurück

void


onExpire()?

ts
optional onExpire: (item, queuer) => void;
optional onExpire: (item, queuer) => void;

Definiert in: async-queuer.ts:159

Callback, der aufgerufen wird, wenn ein Element im Queuer abläuft

Parameter

item

TValue

queuer

AsyncQueuer<TValue>

Gibt zurück

void


onItemsChange()?

ts
optional onItemsChange: (queuer) => void;
optional onItemsChange: (queuer) => void;

Definiert in: async-queuer.ts:163

Callback, der aufgerufen wird, wenn ein Element zum Queuer hinzugefügt oder daraus entfernt wird

Parameter

queuer

AsyncQueuer<TValue>

Gibt zurück

void


onReject()?

ts
optional onReject: (item, queuer) => void;
optional onReject: (item, queuer) => void;

Definiert in: async-queuer.ts:167

Callback, der aufgerufen wird, wenn ein Element abgelehnt wird, weil es nicht zum Queuer hinzugefügt werden kann

Parameter

item

TValue

queuer

AsyncQueuer<TValue>

Gibt zurück

void


onSettled()?

ts
optional onSettled: (item, queuer) => void;
optional onSettled: (item, queuer) => void;

Definiert in: async-queuer.ts:171

Optionaler Callback, der aufgerufen wird, wenn eine Aufgabe abgeschlossen ist

Parameter

item

TValue

queuer

AsyncQueuer<TValue>

Gibt zurück

void


onSuccess()?

ts
optional onSuccess: (result, item, queuer) => void;
optional onSuccess: (result, item, queuer) => void;

Definiert in: async-queuer.ts:175

Optionaler Callback, der aufgerufen wird, wenn eine Aufgabe erfolgreich ist

Parameter

result

any

item

TValue

queuer

AsyncQueuer<TValue>

Gibt zurück

void


started?

ts
optional started: boolean;
optional started: boolean;

Definiert in: async-queuer.ts:179

Ob der Queuer sofort mit der Verarbeitung von Aufgaben beginnen soll oder nicht.


throwOnError?

ts
optional throwOnError: boolean;
optional throwOnError: boolean;

Definiert in: async-queuer.ts:185

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.


wait?

ts
optional wait: number | (queuer) => number;
optional wait: number | (queuer) => number;

Definiert in: async-queuer.ts:191

Zeit in Millisekunden, die zwischen der Verarbeitung von Elementen gewartet werden soll. Kann eine Zahl oder eine Funktion sein, die eine Zahl zurückgibt.

Standard

ts
0
0
Unsere Partner
Code Rabbit
Unkey
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.