Class ObservableQueue<T>

constructor

• new ObservableQueue<T>(options?): ObservableQueue<T>

• Type Parameters

  • T

  Parameters

  • Optionaloptions: ObservableQueueOptions

  Returns ObservableQueue<T>

Readonlyback$

ReadonlybackDelta$

Readonlyempty$

Readonlyfront$

ReadonlyfrontDelta$

ReadonlyitemAdded$

ReadonlyitemDelta$

ReadonlyitemRemoved$

Readonlyitems$

ReadonlyitemUpdates$

Readonlylength$

Readonlyupdates$

back

• get back(): undefined | T

• Element at the back of the queue

  Returns undefined | T

empty

• get empty(): boolean

• True if there are no items in the queue

  Returns boolean

front

• get front(): undefined | T

• Element at the front of the queue

  Returns undefined | T

items

• get items(): T[]

• A list of items in the queue

  Returns T[]
• set items(items): void

• Parameters

  • items: T[]

  Returns void

length

• get length(): number

• The number of items in the queue

  Returns number

maxSize

• get maxSize(): undefined | number

• The max size of the queue

  Returns undefined | number

addToFront

• addToFront(item): void

• Add item to the front of the queue

  Parameters

  • item: T

    Item to add

  Returns void
• addToFront(...items): void

• Add items to the front of the queue

  Parameters

  • Rest...items: T[]

    Items to add

  Returns void

clear

• clear(): void

• Remove all elements from the set

  Returns void

contains

• contains(item): boolean

• Checks if the item exists in the queue

  Parameters

  • item: T

  Returns boolean

dequeue

• dequeue(): undefined | T

• Remove the front element from the queue and return it

  Returns undefined | T
• dequeue(count): T[]

• Remove the front x elements from the queue and return them

  Parameters

  • count: number

    The amount of elements to remove

  Returns T[]

dispose

• dispose(): void

• Dispose of the Queue. This closes all subjects.

  Returns void

enqueue

• enqueue(item): void

• Add item to the back of the queue

  Parameters

  • item: T

    Item to add

  Returns void
• enqueue(...items): void

• Add items to the back of the queue

  Parameters

  • Rest...items: T[]

    Items to add

  Returns void

removeFromBack

• removeFromBack(): undefined | T

• Remove the back element from the queue and return it

  Returns undefined | T
• removeFromBack(count): T[]

• Remove the back x elements from the queue and return it

  Parameters

  • count: number

    The amount of elements to remove

  Returns T[]

removeItem

• removeItem(item): boolean

• Removes an item from the scheduler

  Parameters

  • item: T

  Returns boolean

setMaxSize

• setMaxSize(size): void

• Change the max size of the queue

  Parameters

  • size: undefined | number

    The new max size

  Returns void