Class RingBuffer<T>

constructor

• new RingBuffer<T>(capacity): RingBuffer<T>

• Sets up the ring buffer.

  Type Parameters

  • T

  Parameters

  • capacity: number

    The buffer's capacity.

  Returns RingBuffer<T>

buffer

Readonly capacity

head

size

tail

bottom

• get bottom(): T

• Obtains the latest element (LIFO) without removing it. Throws an exception if a buffer is empty. Before calling this method, make sure that size > 0.

  Returns T

top

• get top(): T

• Obtains the oldest element (FIFO) without removing it. Throws an exception if a buffer is empty. Before calling this method, make sure that size > 0.

  Returns T

asArray

• asArray(): T[]

• Returns a copy of the buffer, where the elements are properly sorted from oldest to newest.

  Returns T[]

clear

• clear(): void

• Clears the contents, removes all elements.

  Returns void

deq

• deq(): T

• Obtains the oldest element (FIFO). May throw an exception if a buffer underrun occurs. Before calling this method, make sure that size > 0.

  Returns T

enq

• enq(...data): void

• Adds one or more elements.

  Parameters

  • Rest ...data: T[]

    The elements to add.

  Returns void

enqOne

• enqOne(data): void

• Adds a single element to the ring buffer.

  Parameters

  • data: T

    Data element.

  Returns void

iterator

• iterator(): Iterator<T>

• Creates an iterator for the buffer.

  Returns Iterator<T>