IQueue
Defined in: packages/data/src/queue/iqueue.ts:14
Interface representing a FIFO (First In First Out) queue.
A queue is a collection that follows the First In First Out (FIFO) principle, where the first item added to the queue is the first one to be removed.
Extends
Section titled “Extends”ICollection<T>
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T extends DefinedValue = DefinedValue
The type of elements in the queue. Anything except undefined,
which means “no element”.
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
Iterator<T,any,any>
Defined in: node_modules/.store/typescript-npm-6.0.3-585eecd158/package/lib/lib.es2015.iterable.d.ts:47
Returns
Section titled “Returns”Iterator<T, any, any>
Inherited from
Section titled “Inherited from”clear()
Section titled “clear()”clear():
void
Defined in: packages/data/src/collection/icollection.ts:23
Removes all elements from the collection.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”count()
Section titled “count()”count():
number
Defined in: packages/data/src/collection/icollection.ts:20
The number of elements in the collection.
A method, not a getter: its async counterpart needs a round trip to the backing store, and a member must have the same shape in both.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”dequeue()
Section titled “dequeue()”dequeue():
T|undefined
Defined in: packages/data/src/queue/iqueue.ts:38
Removes and returns the item at the front of the queue.
Returns
Section titled “Returns”T | undefined
The item at the front of the queue, or undefined if the queue is
empty.
enqueue()
Section titled “enqueue()”enqueue(
item):void
Defined in: packages/data/src/queue/iqueue.ts:22
Adds an item to the rear of the queue.
Parameters
Section titled “Parameters”T
The item to add to the queue.
Returns
Section titled “Returns”void
enqueueAll()
Section titled “enqueueAll()”enqueueAll(
items):void
Defined in: packages/data/src/queue/iqueue.ts:30
Adds every item to the rear of the queue, in array order, so the last one is the last to be dequeued.
Parameters
Section titled “Parameters”readonly T[]
The items to add to the queue.
Returns
Section titled “Returns”void
front()
Section titled “front()”front():
T|undefined
Defined in: packages/data/src/queue/iqueue.ts:46
Returns the item at the front of the queue without removing it.
Returns
Section titled “Returns”T | undefined
The item at the front of the queue, or undefined if the queue is
empty.