Queue

Members

length

The length of the queue.

Source: Core/Queue.js, line 18

Methods

clear()

Remove all items from the queue.

Source: Core/Queue.js, line 69

contains(item)

Check whether this queue contains the specified item.

Name	Type	Description
item	Object	the item to search for.

Source: Core/Queue.js, line 62

dequeue()

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

Source: Core/Queue.js, line 34

enqueue(item)

Enqueues the specified item.

Name	Type	Description
item	Object	The item to enqueue.

Source: Core/Queue.js, line 26

sort(compareFunction)

Sort the items in the queue in-place.

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

Source: Core/Queue.js, line 78

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;
}

Source: Core/Queue.js, line 88