Queue

Members

readonlylength : Number

The length of the queue.

Methods

clear()

Remove all items from the queue.

contains(item)

Check whether this queue contains the specified item.

Name	Type	Description
item	Object	The item to search for.

dequeue() → Object

Dequeues an item. Returns undefined if the queue is empty.

Returns:

The the dequeued item.

enqueue(item)

Enqueues the specified item.

Name	Type	Description
item	Object	The item to enqueue.

peek() → Object

Returns the item at the front of the queue. Returns undefined if the queue is empty.

Returns:

The item at the front of the queue.

sort(compareFunction)

Sort the items in the queue in-place.

Name	Type	Description
compareFunction	Queue~Comparator	A function that defines the sort order.

Type Definitions

Comparator(a, b) → Number

A function used to compare two items while sorting a queue.

Name	Type	Description
a	Object	An item in the array.
b	Object	An item in the array.

Returns:

Returns a negative value if a is less than b, a positive value if a is greater than b, or 0 if a is equal to b.

Example:

function compareNumbers(a, b) {
    return a - b;
}