Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atayahmet/observer-js
Observer-js created based on observer pattern criteria. Create subjects and add it callback as observers.
https://github.com/atayahmet/observer-js
callback observer-js pubsub subjects
Last synced: 28 days ago
JSON representation
Observer-js created based on observer pattern criteria. Create subjects and add it callback as observers.
- Host: GitHub
- URL: https://github.com/atayahmet/observer-js
- Owner: atayahmet
- License: mit
- Created: 2020-02-16T19:50:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-17T07:36:59.000Z (about 4 years ago)
- Last Synced: 2024-10-28T17:38:51.456Z (about 2 months ago)
- Topics: callback, observer-js, pubsub, subjects
- Language: TypeScript
- Size: 32.2 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Create subjects and add observers as callback. ⚡️
[](https://img.shields.io/travis/atayahmet/observer-js?style=flat-square) [](https://img.shields.io/npm/v/@atayahmet/observer-js?style=flat-square)   
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](https://yarnpkg.com/) or [npm](https://www.npmjs.com) to install.
```sh
$ npm i @atayahmet/observer-js --save
```
```sh
$ yarn add @atayahmet/observer-js
```
## Usage
```js
import Subject from '@atayahmet/observer-js';
```
**Create new subject:**
```js
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:**
```js
const subject = new Subject();
const sub$ = subject.subscribe(data => console.log('Remove subscription!', data));
sub$.unsubscribe();
```
**Cancel all observers in one time:**
```js
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:**
```js
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:**
```js
subject.reset();
```
**Get total count of active observers:**
```js
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:**
```js
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
- [TypeScript](https://www.typescriptlang.org)
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/atayahmet/observer-js/tags).
## Authors
- [**Ahmet ATAY**](https://github.com/atayahmet) - _Initial work_
See also the list of [contributors](https://github.com/atayahmet/observer-js/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.
## License
[MIT](https://choosealicense.com/licenses/mit/)