API · Interop

toNodeReadable()

Expose Exstream output through Node's native `Readable` interface.

Example

const readable = exstream(rows).jsonlStringify().toNodeReadable()
readable.pipe(process.stdout)

Behavior

The returned readable pulls from Exstream through its async iterator. Node demand and high-water marks therefore control upstream work; normal completion ends the readable, and destruction cancels the Exstream consumer branch.

options are forwarded to Readable.from(). Exstream uses object mode by default; pass standard Node readable options when another mode or water mark is required.

This adapter is available only in the Node runtime. Browser and portable entry points throw; use toWebReadable() there. Pipeline failures are emitted through the readable’s error event, so attach an error handler or use pipeTo() when a completion promise is a better boundary.

Signature

toNodeReadable(options?: object | null): NodeReadableLike<T>

Related

toNodeTransform(), toWebReadable(), pipeTo(), async iteration