Class StreamReader

Reads CTON documents from a stream

Implements

Iterable<unknown>
AsyncIterable<unknown>

Index

Constructors

Methods

[asyncIterator] [iterator]

Constructors

constructor

new StreamReader(
io: Iterable<string, any, any> | AsyncIterable<string, any, any>,
options?: StreamReaderOptions,
): StreamReader
Parameters
- io: Iterable<string, any, any> | AsyncIterable<string, any, any>
  Input stream (iterable of chunks/lines)
- options: StreamReaderOptions = {}
  Options
Returns StreamReader
- Defined in src/stream.ts:24

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<unknown>
Async iterator for async streams

Returns AsyncGenerator<unknown>
Implementation of AsyncIterable.[asyncIterator]
- Defined in src/stream.ts:66

[iterator]

"[iterator]"(): Generator<unknown>
Iterate over all documents in the stream

Returns Generator<unknown>
Generator yielding parsed documents
Implementation of Iterable.[iterator]
- Defined in src/stream.ts:34