Klasse: Batcher<TValue>

Eine Klasse, die Elemente sammelt und sie in Batches verarbeitet.

Batching ist eine Technik zum Gruppieren mehrerer Operationen, die als eine einzige Einheit verarbeitet werden.

Der Batcher bietet eine flexible Möglichkeit, Batching mit konfigurierbaren

Maximaler Batch-Größe (Anzahl der Elemente pro Batch)
Zeitbasierte Batching (Verarbeitung nach X Millisekunden)
Benutzerdefinierte Batch-Verarbeitungslogik über getShouldExecute
Event-Callbacks zur Überwachung von Batch-Operationen

Zustandsverwaltung

Verwendet TanStack Store für reaktives Zustandsmanagement
Verwenden Sie initialState, um initiale Zustandswerte bei der Erstellung des Batchers bereitzustellen
Verwenden Sie den onExecute-Callback, um auf Batch-Ausführungen zu reagieren und benutzerdefinierte Logik zu implementieren
Verwenden Sie den onItemsChange-Callback, um auf das Hinzufügen oder Entfernen von Elementen aus dem Batcher zu reagieren
Der Zustand umfasst die Anzahl der Batch-Ausführungen, die Gesamtanzahl der verarbeiteten Elemente, die Elemente und den laufenden Status
Der Zustand kann über batcher.store.state zugegriffen werden, wenn die Klasse direkt verwendet wird
Bei Verwendung von Framework-Adaptern (React/Solid) wird auf den Zustand über batcher.state zugegriffen

Beispiel

const batcher = new Batcher<number>(
  (items) => console.log('Processing batch:', items),
  {
    maxSize: 5,
    wait: 2000,
    onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  }
);

batcher.addItem(1);
batcher.addItem(2);
// After 2 seconds or when 5 items are added, whichever comes first,
// the batch will be processed
// batcher.flush() // manually trigger a batch

const batcher = new Batcher<number>(
  (items) => console.log('Processing batch:', items),
  {
    maxSize: 5,
    wait: 2000,
    onExecute: (batch, batcher) => console.log('Batch executed:', batch)
  }
);

batcher.addItem(1);
batcher.addItem(2);
// After 2 seconds or when 5 items are added, whichever comes first,
// the batch will be processed
// batcher.flush() // manually trigger a batch

Typparameter

• TValue

Konstruktoren

new Batcher()

new Batcher<TValue>(fn, initialOptions): Batcher<TValue>

new Batcher<TValue>(fn, initialOptions): Batcher<TValue>

Definiert in: batcher.ts:152

Parameter

fn

(items) => void

initialOptions

BatcherOptions<TValue>

Gibt zurück

Batcher<TValue>

Eigenschaften

fn()

fn: (items) => void;

fn: (items) => void;

Definiert in: batcher.ts:153

Parameter

items

TValue[]

Gibt zurück

void

key

key: string;

key: string;

Definiert in: batcher.ts:148

optionen

options: BatcherOptionsWithOptionalCallbacks<TValue>;

options: BatcherOptionsWithOptionalCallbacks<TValue>;

Definiert in: batcher.ts:149

store

readonly store: Store<Readonly<BatcherState<TValue>>>;

readonly store: Store<Readonly<BatcherState<TValue>>>;

Definiert in: batcher.ts:145

Methoden

addItem()

addItem(item): void

addItem(item): void

Definiert in: batcher.ts:204

Fügt ein Element zum Batcher hinzu. Wenn die Batch-Größe erreicht ist, ein Timeout auftritt oder shouldProcess true zurückgibt, wird der Batch verarbeitet.