Members

frozen :Boolean

index.js, line 35

frozenCB :function

index.js, line 45

length :string

index.js, line 25

queue :Array

index.js, line 20

Methods

add(item) → {Boolean}

index.js, line 78

Adds one item to the end of the queue

Parameters:

Name	Type	Description
item	*	Item to be added to queue

Returns:

Boolean - Indicates if it was successful

addToBeginning(item) → {Boolean}

index.js, line 91

Add one item to the beginning of the queue

Parameters:

Name	Type	Description
item	*	Item to be added to queue

Returns:

Boolean - Indicates if it was successful

freeze()

index.js, line 50

Freezes the queue

freezeCheck() → {Boolean}

index.js, line 63

Checks if frozen and executes CB if one is provided Internal FN designed for lib use

Returns:

Boolean - Indicates if it was frozen

getAll() → {Array|Boolean}

index.js, line 127

Gets all items currently in the queue

Returns:

Array | Boolean - All items in queue or false if frozen

getIndex(index, qty) → {Array|Boolean}

index.js, line 140

Take an item out of the queue at a specific index

Parameters:

Name	Type	Default	Description
index	Number	0	The index to start at
qty	Number	1	The number of records to retrieve

Returns:

Array | Boolean - Returns an array of values or false if frozen

getLast(qty) → {Array|Boolean}

index.js, line 116

Gets the last item from the queue

Parameters:

Name	Type	Default	Description
qty	Number	1	The quantity to be returned

Returns:

Array | Boolean - Returns an array of values or false if frozen

getNext(qty) → {Array|Boolean}

index.js, line 104

Gets the next items in queue

Parameters:

Name	Type	Default	Description
qty	Number	1	The quantity to be returned starting from index 0

Returns:

Array | Boolean - Returns an array of values or false if frozen

remove(item) → {Boolean}

index.js, line 152

Locates the item and removes it from the queue

Parameters:

Name	Type	Description
item	*	Must be the EXACT item (===) comparison done

Returns:

Boolean - Indicates if the item was removed or not

removeIndex(index) → {Boolean}

index.js, line 168

Remove one item based on the array index

Parameters:

Name	Type	Default	Description
index	Number	0	Index of the item to be removed

Returns:

Boolean - Indicates if the item was removed or not

unfreeze()

index.js, line 55

Unfreeze the queue