2016-07-21 22:16:45 +00:00
|
|
|
# lik
|
|
|
|
|
light little helpers for node
|
|
|
|
|
|
2016-09-21 11:57:23 +00:00
|
|
|
## Availabililty
|
|
|
|
|
[](https://www.npmjs.com/package/lik)
|
|
|
|
|
[](https://gitlab.com/pushrocks/lik)
|
|
|
|
|
[](https://github.com/pushrocks/lik)
|
|
|
|
|
[](https://pushrocks.gitlab.io/lik/gitbook)
|
|
|
|
|
|
|
|
|
|
## Status for master
|
2016-07-21 22:40:51 +00:00
|
|
|
[](https://gitlab.com/pushrocks/lik/commits/master)
|
2016-09-21 11:57:23 +00:00
|
|
|
[](https://gitlab.com/pushrocks/lik/commits/master)
|
|
|
|
|
[](https://david-dm.org/pushrocks/lik)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/lik/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/lik)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
2016-07-21 22:16:45 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
We recommend the use of TypeScript for good intellisense.
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
// import any tool that you need from lik
|
2016-09-23 08:20:20 +00:00
|
|
|
import { Stringmap, Objectmap, Observablemap } from "lik";
|
2016-09-21 11:51:37 +00:00
|
|
|
```
|
|
|
|
|
|
2016-09-23 08:20:20 +00:00
|
|
|
### class Stringmap
|
|
|
|
|
Stringmap allows you to keep track of strings. It allows you to register triggers for certain events
|
|
|
|
|
like when a certain string is removed or added to the map
|
|
|
|
|
|
|
|
|
|
### class Objectmap
|
|
|
|
|
Sometimes you need to keep track of objects, but implementing logic for removing, finding or updating is tedious.
|
|
|
|
|
Objectmap takes care of keeping track of objects for you.
|
|
|
|
|
|
|
|
|
|
### 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 a detailed class overview, please take a look at the API docs**
|
|
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
