Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 1.16 KB

README.md

File metadata and controls

23 lines (14 loc) · 1.16 KB

bacon-node-stream

Utility for creating Node.js readable streams from Bacon streams and vice versa.

Usage

Install this package and baconjs, that is this package's peer dependency.

API

readableToBacon(stream: Readable, options?: ReadableOptions): Bacon.EventStream<any, any>

Creates a new Node.js stream that is exposed as a Bacon event stream and pipes stream into it. Use this function for creating a Bacon EventStream from a Readable stream. You must provide the options accordingly, so if stream uses object mode, you must also specify it here, and so on.

Note to TypeScript users: Readable's values are not typed, so you must cast or determine the correct type yourself (use .map()).

baconToReadable(stream: Bacon.EventStream<any, any>, options?: ReadableOptions): Readable {

Wraps a Bacon event stream as a Node.js Readable stream. If the Readable is paused all values, errors and the possible end event of the stream are buffered until the Readable is resumed. Remember to provide options if your stream uses the object mode.