Interface NDJSONStream<T, Stream>

interface NDJSONStream<T = any, Stream = unknown> {
    read(options?: AbortOptions): Promise<T>;
    unwrap(): Stream;
    write(input: T, options?: AbortOptions): Promise<void>;
}

Type Parameters

T = any
Stream = unknown

Index

Methods

read unwrap write

Methods

read

read(options?: AbortOptions): Promise<T>
Read the next message from the stream
Parameters
- Optionaloptions: AbortOptions
Returns Promise<T>
- Defined in it-ndjson-stream/src/index.ts:38

unwrap

unwrap(): Stream
Returns the underlying stream

Returns Stream
- Defined in it-ndjson-stream/src/index.ts:48

write

write(input: T, options?: AbortOptions): Promise<void>
Write the passed message to the stream
Parameters
- input: T
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in it-ndjson-stream/src/index.ts:43