Class DataBuffer<T>

Holds a data in a ring-buffer.

Type Parameters

T

Implements

IReadOnlyDataBuffer<T>

Index

Constructors

Properties

Methods

[iterator] at clear filter push slice sliceAndFilter view

Constructors

constructor

new DataBuffer<T>(size?: number): DataBuffer<T>
Constructor.
Type Parameters
- T
Parameters
- size: number = 0
  An optional buffer size.
Returns DataBuffer<T>

Properties

length

length: number = 0

Methods

[iterator]

"[iterator]"(): DataBufferView<T>
Returns DataBufferView<T>
Implementation of IReadOnlyDataBuffer.[iterator]

at

at(index: number): T
Takes an integer value and returns the item at that index, allowing for positive and negative integers. Negative integers count back from the last item in the array.
Parameters
- index: number
Returns T
Implementation of IReadOnlyDataBuffer.at

clear

clear(size?: number): void
Clears this DataBuffer.
Parameters
- Optionalsize: number
  An optional new buffer size.
Returns void

filter

filter(filter: (value: T) => boolean): DataBufferView<T>
Returns an iterator of a section of this buffer.
Parameters
- filter: (value: T) => boolean
  An optional callback filter.
Returns DataBufferView<T>

push

push(...elements: T[]): void
Adds data to this DataBuffer.
Parameters
- ...elements: T[]
  The new elements.
Returns void

slice

slice(start: number, end?: number): DataBufferView<T>
Returns an iterator of a section of this buffer.
Parameters
- start: number
  The beginning index of the specified portion of the buffer.
- Optionalend: number
  The end index of the specified portion of the buffer. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the buffer.
Returns DataBufferView<T>

sliceAndFilter

sliceAndFilter(
    start: number,
    end?: number,
    filter?: (value: T) => boolean,
): DataBufferView<T>
Returns an iterator of a section of this buffer.
Parameters
- start: number
  The beginning index of the specified portion of the buffer.
- Optionalend: number
  The end index of the specified portion of the buffer. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the buffer.
- Optionalfilter: (value: T) => boolean
  An optional callback filter.
Returns DataBufferView<T>

view

view(): DataBufferView<T>
Returns DataBufferView<T>