Type Alias QueueMutableEvents<V>

QueueMutableEvents<V>: {
    dequeue: {
        finalData: ReadonlyArray<V>;
        removed: V;
    };
    enqueue: {
        added: ReadonlyArray<V>;
        finalData: ReadonlyArray<V>;
    };
    removed: {
        finalData: ReadonlyArray<V>;
        removed: ReadonlyArray<V>;
    };
}

Type Parameters

  • V

Type declaration

  • dequeue: {
        finalData: ReadonlyArray<V>;
        removed: V;
    }

    Single item dequeued. When dequeing the 'removed' event also fires

    • finalData: ReadonlyArray<V>
    • removed: V
  • enqueue: {
        added: ReadonlyArray<V>;
        finalData: ReadonlyArray<V>;
    }

    Data has been added

    • added: data attempted to be added. Note: not all of it may have been accepted into queue
    • finalData: actual state of queue
    • added: ReadonlyArray<V>
    • finalData: ReadonlyArray<V>
  • removed: {
        finalData: ReadonlyArray<V>;
        removed: ReadonlyArray<V>;
    }

    One or more items removed due to dequeuing, clearing or removeWhere called

    • finalData: ReadonlyArray<V>
    • removed: ReadonlyArray<V>