Interface Batch<T>

A generic batch processing queue, implemented as a set. (So items are processed at most once per batch run.)

interface Batch<T> {
    add(item: T): void;
    delete(item: T): void;
    flush: (() => void);
    has(item: any): boolean;
    isEmpty(): boolean;
    isRunning(): boolean;
}

Type Parameters

  • T

    The type of items that will be in the batch

Properties

flush

Methods

add delete has isEmpty isRunning

Properties

Readonly flush

flush: (() => void)

Process the batch now by calling the processing function, unless the batch is empty or already running. If the processing function exits without fully emptying the batch (due to errors, time limits, etc.), another flush will be scheduled via the batch's scheduler (unless one is already scheduled).

Type declaration

    • (): void

    • Returns void

Methods

add

  • add(item: T): void

  • Add an item to the batch. Schedules the batch for processing if the batch was empty and is not already scheduled. (Does nothing if the item is already in the batch.)

    Parameters

    • item: T

    Returns void

delete

  • delete(item: T): void

  • Remove an item from the batch. (Does not affect the schedule.)

    Parameters

    • item: T

    Returns void

has

  • has(item: any): boolean

  • Is the item in the batch?

    Parameters

    • item: any

    Returns boolean

isEmpty

isRunning

  • isRunning(): boolean

  • Is the batch processing function currently running?

    Returns boolean

Settings

Member Visibility

Theme

On This Page

flushadddeletehasisEmptyisRunning