IDeltaQueue Interface

Packages > @fluidframework/container-definitions > IDeltaQueue

Queue of ops to be sent to or processed from storage

Signature:

export interface IDeltaQueue<T> extends IEventProvider<IDeltaQueueEvents<T>>, IDisposable 

Extends: IEventProvider<IDeltaQueueEvents<T>>, IDisposable

Properties

List of properties of this interface
Property Type Description
idle boolean Flag indicating whether or not the queue is idle
length number The number of messages remaining in the queue
paused boolean Flag indicating whether or not the queue was paused

Methods

List of methods of this class
Method Description
pause() Pauses processing on the queue
peek() Peeks at the next message in the queue
resume() Resumes processing on the queue
toArray() Returns all the items in the queue as an array. Does not remove them from the queue.
waitTillProcessingDone()

Events

idle

Flag indicating whether or not the queue is idle

Signature:

idle: boolean;

length

The number of messages remaining in the queue

Signature:

length: number;

paused

Flag indicating whether or not the queue was paused

Signature:

paused: boolean;

Methods

pause

Pauses processing on the queue

Signature:

pause(): Promise<void>;

Returns:

Promise<void>

A promise which resolves when processing has been paused.

peek

Peeks at the next message in the queue

Signature:

peek(): T | undefined;

Returns:

T | undefined

resume

Resumes processing on the queue

Signature:

resume(): void;

Returns:

void

toArray

Returns all the items in the queue as an array. Does not remove them from the queue.

Signature:

toArray(): T[];

Returns:

T[]

waitTillProcessingDone

Signature:

waitTillProcessingDone(): Promise<void>;

Returns:

Promise<void>