1.0.0 • Published 5 years ago
@zkochan/zen-push v1.0.0
@zkochan/zen-push
A push stream observable class. (Sometimes called a Subject in Rx-speak.)
Install
npm install @zkochan/zen-push
Usage
import PushStream from '@zkochan/zen-push';
let pushStream = new PushStream();
pushStream.observable.subscribe(value => console.log(`Hello ${value}!`));
pushStream.next('World'); // 'Hello World!'
API
new PushStream ( )
let pushStream = new PushStream();
Creates a new PushStream object.
pushStream.observable
pushStream.observable.subscribe(value => console.log(`Hello ${value}!`));
The instance of Observable used to listen to elements in the push stream.
pushStream.next ( value )
pushStream.next('World');
Sends the next stream value to all observers.
pushStream.error ( error )
pushStream.error(new Error('The planet as been destroyed'));
Sends an error to all observers. Calling this method terminates the stream.
pushStream.complete ( )
pushStream.complete();
Sends a signal to all observers that the stream is finished. Calling this method terminates the stream.
License
MIT
1.0.0
5 years ago