53 lines
2.8 KiB
Markdown
53 lines
2.8 KiB
Markdown
# @push.rocks/lik
|
|
light little helpers for node
|
|
|
|
## Availabililty and Links
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/lik)
|
|
* [gitlab.com (source)](https://gitlab.com/push.rocks/lik)
|
|
* [github.com (source mirror)](https://github.com/push.rocks/lik)
|
|
* [docs (typedoc)](https://push.rocks.gitlab.io/lik/)
|
|
|
|
## Status for master
|
|
|
|
Status Category | Status Badge
|
|
-- | --
|
|
GitLab Pipelines | [](https://lossless.cloud)
|
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
npm | [](https://lossless.cloud)
|
|
Snyk | [](https://lossless.cloud)
|
|
TypeScript Support | [](https://lossless.cloud)
|
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
Code Style | [](https://lossless.cloud)
|
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```javascript
|
|
// import any tool that you need from lik
|
|
import { Stringmap, Objectmap, Observablemap } from 'lik';
|
|
```
|
|
|
|
### 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.
|
|
|
|
## Contribution
|
|
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
## Legal
|
|
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|