Class default<T>

Type Parameters

  • T

Hierarchy

  • default<T>
    • default

Constructors

constructor

Properties

_array _head _size _tail

Accessors

count isEmpty

Methods

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

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • Optional initialEntries: T[]

    Returns default<T>

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

    Returns number

isEmpty

  • get isEmpty(): boolean

  • Returns true if the queue is empty.

    Returns

    Returns boolean

Methods

Protected _dequeueInternal

  • _dequeueInternal(): undefined | T

  • Returns undefined | T

Protected _enqueueInternal

  • _enqueueInternal(item: T): void

  • Parameters

    • item: T

    Returns void

Protected _getIterator

  • _getIterator(): Iterator<T, any, undefined>

  • Returns Iterator<T, any, undefined>

Protected _peekInternal

  • _peekInternal(): undefined | T

  • Returns undefined | T

clear

  • Returns number

consumer

  • Produces an iterable that dequeues items when iterated. Stops when empty.

    Returns

    Returns Iterable<T>

dequeue

  • Pulls an entry from the head of the queue and returns it. Returns undefined if the queue is already empty.

    Returns 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.

    Throws

    If the queue is already empty and throwIfEmpty is true.

    Parameters

    • throwIfEmpty: true

    Returns 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.

    Throws

    If the queue is already empty and throwIfEmpty is true.

    Parameters

    • throwIfEmpty: boolean

    Returns undefined | T

dispose

  • Clears the list.

    Returns void

dump

  • Dequeues entries into an array.

    Parameters

    • max: number = Infinity

    Returns T[]

enqueue

  • Adds an item to the end of the queue.

    Returns

    Parameters

    • value: T

    Returns default<T>

enqueueMultiple

  • Adds items to the end of the queue.

    Returns

    Parameters

    • values: Iterable<T>

    Returns default<T>

enqueueThese

  • Adds items to the end of the queue.

    Returns

    Parameters

    • Rest ...values: T[]

    Returns default<T>

getCount

  • Returns number

peek

  • Returns the entry at the head of the queue. Returns undefined if the queue is already empty.

    Returns undefined | T

  • Returns the entry at the head of the queue. Returns undefined if the queue is already empty and throwIfEmpty is false.

    Throws

    If the queue is already empty and throwIfEmpty is true.

    Parameters

    • throwIfEmpty: true

    Returns T

  • Returns the entry at the head of the queue. Returns undefined if the queue is already empty and throwIfEmpty is false.

    Throws

    If the queue is already empty and throwIfEmpty is true.

    Parameters

    • throwIfEmpty: boolean

    Returns undefined | T

recycle

  • Clears the list.

    Returns void

setCapacity

trimExcess

  • Trims excess items in the underlying array.

    Parameters

    • Optional threshold: number

    Returns void

tryDequeue

  • 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.

    Returns

    True if a value was retrieved. False if not.

    Parameters

    • out: ((value: T) => void)

      The 'out' handler that receives the value if it exists.

        • (value: T): void

        • Parameters

          • value: T

          Returns void

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc