57 lines
2.9 KiB
Markdown
57 lines
2.9 KiB
Markdown
# @pushrocks/smartunique
|
|
make things unique
|
|
|
|
## 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/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartunique/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartunique/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartunique)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartunique)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## 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';
|
|
|
|
// 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
|
|
|
|
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)
|
|
|
|
[](https://push.rocks)
|
|
|
|
|
|
## 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)
|
|
|
|
[](https://maintainedby.lossless.com)
|