Class Stream<T>

Data stream.

Type parameters

T

The type of the streamed data.

Hierarchy

Stream

Index

Constructors

constructor

Methods

Constructors

constructor

new Stream(options: StreamOptions, infiniteReset: (value: T) => T): Stream

- Defined in stream.ts:77
Create a new instance of a stream.

Parameters
- options: StreamOptions
  
  The options to use to construct this stream.
- infiniteReset: (value: T) => T
  
  A function to use when offsetting the data during moving it to back of the data stream
  - - (value: T): T
    - Parameters
      - value: T
      Returns T
Returns Stream

Methods

forEach

forEach(handler: (value: T, index: number, array: T[]) => void): void

- Defined in stream.ts:209
Calls the handler for each element of the stream.

Parameters
- handler: (value: T, index: number, array: T[]) => void
  
  A function that works just like a normal JavaScript Array.prototype.forEach handler.
  - - (value: T, index: number, array: T[]): void
    - Parameters
      - value: T
      - index: number
      - array: T[]
      Returns void
Returns void

map

map(handler: (value: T, index: number, array: T[]) => T): Stream<T>

- Defined in stream.ts:184
Maps the stream of data.

Parameters
- handler: (value: T, index: number, array: T[]) => T
  
  A function that works just like a normal JavaScript Array.prototype.map handler.
  - - (value: T, index: number, array: T[]): T
    - Parameters
      - value: T
      - index: number
      - array: T[]
      Returns T
Returns Stream<T>

A new stream with the data mapped by the handler.

push

push(newData: T | T[]): void

- Defined in stream.ts:170
Push new data to the end of stream.

Parameters
- newData: T | T[]
  
  New data point
Returns void