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

BREAKING CHANGE(scope): update scope

Browse Source
This commit is contained in:
Philipp Kunz
2018-10-06 15:38:55 +02:00
parent 79f78550ba
commit 17ecde59d5
15 changed files with 1033 additions and 503 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/index.md
View File

@ -1,13 +1,16 @@
# smartunique
make things unique
## Availabililty
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartunique)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartunique)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartunique)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartunique/)
## Status for master
[![build status](https://GitLab.com/pushrocks/smartunique/badges/master/build.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/smartunique.svg)](https://www.npmjs.com/package/smartunique)
@ -19,20 +22,21 @@ make things unique
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
```javascript
// We are using TypeScript syntax here to have types in place
import * as smartunique from 'smartunique'
import * as smartunique from 'smartunique';
// creates a short mathematically highly unique short string
let myShortid = smartunique.shortid()
let myShortid = smartunique.shortid();
// creates a string that is possibly unique world wide
let myUuid4 = smartunique.uuid4()
let myUuid4 = smartunique.uuid4();
// creates a oneway repeatable unique id within a certain namespace
let myUuid5 = smartunique.uuid('myobscureduser@somedomain.com', smartunique.uuid4())
let myUuid5 = smartunique.uuid('myobscureduser@somedomain.com', smartunique.uuid4());
```
Learn more about UUIDs: knowledgebase.gitzone.com/uuid.html
@ -40,6 +44,6 @@ Learn more about UUIDs: knowledgebase.gitzone.com/uuid.html
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)
> | 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)