@atayahmet/observer-js
v1.0.0
Published
Observer js created based on observer pattern criteria. Create subjects and add it callback as observer.
Downloads
12
Maintainers
Readme
Simple light-weight observable pub/sub library. You can create multiple subject and observers and manage these objects using features.
Note: All subscriptions work asynchronously.
Installation
Use the package manager yarn or npm to install.
$ npm i @atayahmet/observer-js --save
$ yarn add @atayahmet/observer-js
Usage
import Subject from '@atayahmet/observer-js';
Create new subject:
const subject = new Subject();
// start subscribe
subject.subscribe(data => console.log('Test subscribe 1!', data));
subject.subscribe(data => console.log('Test subscribe 2!', data));
// run all observers.
subject.notify('Hello World!');
Unsubscribe an observer:
const subject = new Subject();
const sub$ = subject.subscribe(data => console.log('Remove subscription!', data));
sub$.unsubscribe();
Cancel all observers in one time:
subject.subscribe(() => console.log('Test subscribe 1!'));
subject.subscribe(() => console.log('Test subscribe 2!'));
// cancelled.
subject.cancel();
// this will not notify to all observers one time
subject.notify();
Pause and Resume observers:
subject.subscribe(() => console.log('Test subscribe 1!'));
subject.subscribe(() => console.log('Test subscribe 2!'));
// paused all observers.
subject.pause();
// this will not notify observers until you resume observers.
subject.notify();
// activate all observers again.
subject.resume();
Reset the subject completely:
subject.reset();
Get total count of active observers:
const sub1$ = subject.subscribe(() => console.log('Test subscribe 1!'));
const sub2$ = subject.subscribe(() => console.log('Test subscribe 2!'));
subject.size(); // output: 2
sub1$.unsubscribe();
subject.size(); // output: 1
onCompleted:
subject.subscribe(data => console.log('Test subscribe 1!'));
subject.subscribe(data => console.log('Test subscribe 2!'));
subject.onCompleted(() => console.log('All observers worked successfuly!'));
subject.notify('Go!');
Built With
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Ahmet ATAY - Initial work
See also the list of contributors who participated in this project.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.