Compare commits

..

2 Commits

Author SHA1 Message Date
30e23a77b7 1.0.21 2016-09-23 10:20:32 +02:00
b228c3b2f0 improve README 2016-09-23 10:20:20 +02:00
2 changed files with 19 additions and 3 deletions

View File

@ -22,7 +22,23 @@ We recommend the use of TypeScript for good intellisense.
```typescript
// import any tool that you need from lik
import { Stringmap, Objectmap } from "lik";
import { Stringmap, Objectmap, Observablemap } from "lik";
```
For a class overview, please read the docs
### 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**
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

View File

@ -1,6 +1,6 @@
{
"name": "lik",
"version": "1.0.20",
"version": "1.0.21",
"description": "light little helpers for node",
"main": "dist/index.js",
"typings": "dist/index.d.ts",