update docs
This commit is contained in:
parent
02bce51ef6
commit
b1652cc2ed
29
docs/index.md
Normal file
29
docs/index.md
Normal file
@ -0,0 +1,29 @@
|
||||
# smartrx
|
||||
smart wrapper for rxjs
|
||||
|
||||
## Availabililty
|
||||
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartrx)
|
||||
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartrx)
|
||||
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartrx)
|
||||
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartrx/)
|
||||
|
||||
## Status for master
|
||||
[![build status](https://GitLab.com/pushrocks/smartrx/badges/master/build.svg)](https://GitLab.com/pushrocks/smartrx/commits/master)
|
||||
[![coverage report](https://GitLab.com/pushrocks/smartrx/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartrx/commits/master)
|
||||
[![npm downloads per month](https://img.shields.io/npm/dm/smartrx.svg)](https://www.npmjs.com/package/smartrx)
|
||||
[![Dependency Status](https://david-dm.org/pushrocks/smartrx.svg)](https://david-dm.org/pushrocks/smartrx)
|
||||
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartrx/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartrx/master/dependencies/npm)
|
||||
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartrx/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartrx)
|
||||
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
|
||||
|
||||
## Usage
|
||||
Use TypeScript for best in class instellisense.
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
|
8
docs/observablemap.md
Normal file
8
docs/observablemap.md
Normal file
@ -0,0 +1,8 @@
|
||||
# class Observablemap
|
||||
|
||||
Event Emitters are nice. However often times you end up with registering multiple listeners for the exact same thing.
|
||||
Observables have a smaller footprint and a more manageable subscribe logic.
|
||||
Observablemap registers only one rxjs observable per event and then continues to reference
|
||||
the same observable that you can subscribe to.
|
||||
|
||||
For further information read the linked docs at the top of this README.
|
@ -6,5 +6,10 @@
|
||||
},
|
||||
"npmdocker": {
|
||||
"command": "rm -r node_modules && yarn install && yarn test"
|
||||
},
|
||||
"npmts": {
|
||||
"testConfig": {
|
||||
"parallel": false
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user