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
| 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
| Method | Description |
|---|---|
| pause() | Pauses processing on the queue |
| peek() | Peeks at the next message in the queue |
| resume() | Resumes processing on the queue |
| systemPause() | System level pause |
| systemResume() | System level resume |
| toArray() | Returns all the items in the queue as an array. Does not remove them from the queue. |
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
systemPause
System level pause
Signature:
systemPause(): Promise<void>;
Returns:
Promise<void>
A promise which resolves when processing has been paused.
systemResume
System level resume
Signature:
systemResume(): 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[]