push.rocks/smartunique
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1ee8930525
smartunique/readme.md

57 lines
2.9 KiB
Markdown
Raw Normal View History

fix(core): update
2018-10-06 15:01:10 +00:00
# @pushrocks/smartunique
initial
2017-07-14 15:18:27 +00:00
make things unique
fix(core): update
2020-03-05 20:39:44 +00:00
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartunique)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartunique)
* [github.com (source mirror)](https://github.com/pushrocks/smartunique)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartunique/)
initial
2017-07-14 15:18:27 +00:00
## Status for master
fix(core): update
2020-03-05 20:39:44 +00:00
[![pipeline status](https://gitlab.com/pushrocks/smartunique/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartunique/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartunique/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartunique/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartunique.svg)](https://www.npmjs.com/package/@pushrocks/smartunique)
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartunique/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartunique)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
initial
2017-07-14 15:18:27 +00:00
## Usage
BREAKING CHANGE(scope): update scope
2018-10-06 13:38:55 +00:00
initial
2017-07-14 15:18:27 +00:00
Use TypeScript for best in class instellisense.
fix(core): update
2018-10-06 15:01:10 +00:00
```javascript
// We are using TypeScript syntax here to have types in place
import * as smartunique from 'smartunique';
// creates a short mathematically highly unique short string
let myShortid = smartunique.shortid();
// creates a string that is possibly unique world wide
let myUuid4 = smartunique.uuid4();
// creates a oneway repeatable unique id within a certain namespace
let myUuid5 = smartunique.uuid('myobscureduser@somedomain.com', smartunique.uuid4());
```
Learn more about UUIDs: knowledgebase.gitzone.com/uuid.html
initial
2017-07-14 15:18:27 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
fix(core): update
2018-10-06 15:01:10 +00:00
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbh/privacy)
initial
2017-07-14 15:18:27 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
fix(core): update
2020-03-05 20:39:44 +00:00
## 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.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
Reference in New Issue Copy Permalink