Class default<T>

Type Parameters

T

Hierarchy

default<T>
- default

Index

Constructors

Properties

_array _head _size _tail

Accessors

Methods

_dequeueInternal _enqueueInternal _peekInternal clear consumer dequeue dispose dump enqueue enqueueMultiple enqueueThese getCount peek recycle setCapacity trimExcess tryDequeue

Constructors

constructor

new default<T>(initialEntries?: T[]): default<T>
Type Parameters
- T
Parameters
- OptionalinitialEntries: T[]
Returns default<T>
Overrides QueueBase<T>.constructor
- Defined in Queue.ts:24

Properties

`Protected`_array

_array: T[]

`Protected`_head

_head: number = 0

`Protected`_size

_size: number = 0

`Protected`_tail

_tail: number = 0

Accessors

count

get count(): number
The number of items currently in the queue.

Returns number
Inherited from QueueBase.count
- Defined in QueueBase.ts:16

isEmpty

get isEmpty(): boolean
Returns true if the queue is empty.

Returns boolean
Inherited from QueueBase.isEmpty
- Defined in QueueBase.ts:25

Methods

`Protected`_dequeueInternal

_dequeueInternal(): undefined | T
Returns undefined | T
Overrides QueueBase._dequeueInternal
- Defined in Queue.ts:181

`Protected`_enqueueInternal

_enqueueInternal(item: T): void
Parameters
- item: T
Returns void
Overrides QueueBase._enqueueInternal
- Defined in Queue.ts:160

`Protected`_peekInternal

_peekInternal(): undefined | T
Returns undefined | T
Overrides QueueBase._peekInternal
- Defined in Queue.ts:192

clear

clear(): number
Clears the list.

Returns number
Overrides QueueBase.clear
- Defined in Queue.ts:42

consumer

consumer(): Iterable<T>
Produces an iterable that dequeues items when iterated. Stops when empty.

Returns Iterable<T>
Inherited from QueueBase.consumer
- Defined in QueueBase.ts:74

dequeue

dequeue(): undefined | T
Pulls an entry from the head of the queue and returns it. Returns undefined if the queue is already empty.

Returns undefined | T
Inherited from QueueBase.dequeue
- Defined in QueueBase.ts:93
dequeue(throwIfEmpty: true): T
Pulls an entry from the head of the queue and returns it. Returns undefined if the queue is already empty and throwIfEmpty is false.
Parameters
- throwIfEmpty: true
Returns T
Throws
If the queue is already empty and throwIfEmpty is true.
Inherited from QueueBase.dequeue
- Defined in QueueBase.ts:101
dequeue(throwIfEmpty: boolean): undefined | T
Pulls an entry from the head of the queue and returns it. Returns undefined if the queue is already empty and throwIfEmpty is false.
Parameters
- throwIfEmpty: boolean
Returns undefined | T
Throws
If the queue is already empty and throwIfEmpty is true.
Inherited from QueueBase.dequeue
- Defined in QueueBase.ts:109

dispose

dispose(): void
Clears the list.

Returns void
Inherited from QueueBase.dispose
- Defined in QueueBase.ts:191

dump

dump(max?: number): T[]
Dequeues entries into an array.
Parameters
- max: number = Infinity
Returns T[]
Overrides QueueBase.dump
- Defined in Queue.ts:59

enqueue

enqueue(value: T): this
Adds an item to the end of the queue.
Parameters
- value: T
Returns this
Inherited from QueueBase.enqueue
- Defined in QueueBase.ts:35

enqueueMultiple

enqueueMultiple(values: Iterable<T>): this
Adds items to the end of the queue.
Parameters
- values: Iterable<T>
Returns this
Inherited from QueueBase.enqueueMultiple
- Defined in QueueBase.ts:47

enqueueThese

enqueueThese(...values: T[]): this
Adds items to the end of the queue.
Parameters
- ...values: T[]
Returns this
Inherited from QueueBase.enqueueThese
- Defined in QueueBase.ts:65

getCount

getCount(): number
Returns the number of items contained in the collection by iterating the contents.

Returns number
Overrides QueueBase.getCount
- Defined in Queue.ts:37

peek

peek(): undefined | T
Returns the entry at the head of the queue. Returns undefined if the queue is already empty.

Returns undefined | T
Inherited from QueueBase.peek
- Defined in QueueBase.ts:145
peek(throwIfEmpty: true): T
Returns the entry at the head of the queue. Returns undefined if the queue is already empty and throwIfEmpty is false.
Parameters
- throwIfEmpty: true
Returns T
Throws
If the queue is already empty and throwIfEmpty is true.
Inherited from QueueBase.peek
- Defined in QueueBase.ts:153
peek(throwIfEmpty: boolean): undefined | T
Returns the entry at the head of the queue. Returns undefined if the queue is already empty and throwIfEmpty is false.
Parameters
- throwIfEmpty: boolean
Returns undefined | T
Throws
If the queue is already empty and throwIfEmpty is true.
Inherited from QueueBase.peek
- Defined in QueueBase.ts:161

recycle

recycle(): void
Clears the list.

Returns void
Inherited from QueueBase.recycle
- Defined in QueueBase.ts:199

setCapacity

setCapacity(capacity: number): this
Parameters
- capacity: number
Returns this
- Defined in Queue.ts:82

trimExcess

trimExcess(threshold?: number): void
Trims excess items in the underlying array.
Parameters
- Optionalthreshold: number
Returns void
- Defined in Queue.ts:152

tryDequeue

tryDequeue(out: (value: T) => void): boolean
Checks to see if the queue has entries an pulls an entry from the head of the queue and passes it to the out handler.
Parameters
- out: (value: T) => void
  The 'out' handler that receives the value if it exists.
Returns boolean
True if a value was retrieved. False if not.
Overrides QueueBase.tryDequeue
- Defined in Queue.ts:136