README
uuid
Locally ordered UUID generator
๐งญ Table of contents
- โจ Benefits
- ๐ Requierments
- ๐ Quickstart
- ๐ Documentation
- ๐ Troubleshooting
- ๐ค Contributing
- ๐งช Testing
- โ๏ธ License
โจ Benefits
- Ordered locally - compatible with Array.sort()
- Math.random() is used (+ speed, - pseudorandom)
- Total length 32
- Each character is 32 bit based on base32hex
- First 9 charaters for timestamp (max. 12 December 3084)
- 5 characters for counter max. 33 554 432 per milisecond
- Last 18 charaters for 32^18 (pseudo)randomness
๐ Requierments
No requierments.
๐ Quickstart
Install
NodeJS
Install using the terminal:
npm install @danielcobo/uuid
Require the module:
const uuid = require('@danielcobo/uuid');
Note: In case you're wondering, @danielcobo/ is just a namespace scope - an NPM feature. Scopes make it easier to name modules and improve security.
Browser
Declare it as a global variable named uuid by including this script before any script you want to use it in:
<script src="https://cdn.jsdelivr.net/npm/@danielcobo/uuid@1/dist/iife/uuid.min.js"></script>
Or import it as an ECMAScript module:
import * as uuid from 'https://cdn.jsdelivr.net/npm/@danielcobo/uuid@1/dist/esm/uuid.min.js';
Also, feel free to download the file if you prefer not to use jsdelivr. In that case just replace the url with the relative file path.
Example use
uuid(); //1fqiv3sqf00000rce854qeufemti2rgr
uuid("id"); //id1fqiv3sqf00000rce854qeufemti2rgr
For details see documentation below.
๐ Documentation
uuid()
Generate locally ordered UUIDs
Name | Type | Default | Description |
---|---|---|---|
[prepend] | string |
"" | String to start ID with (UUID length becomes 32 + length of this string) |
Returns
Type | Description |
---|---|
string |
UUID |
Source: src/index.js:40
๐ Troubleshooting
If you run into trouble or have questions just submit an issue.
๐ค Contributing
Anyone can contribute
Contributions come in many shapes and sizes. All are welcome. You can contribute by:
- asking questions
- suggesting features
- sharing this repo with friends
- improving documentation (even fixing typos counts ๐)
- providing tutorials (if you do, please let me know, I would love to read them)
- improving tests
- contributing code (new features, performance boosts, code readability improvements..)
Rules for contributions
General guidelines:
- there are no dumb questions
- be polite and respectful to others
- do good
When coding remember:
- working > maintainability > performance
- best code is no code
- be descriptive when naming
- keep it DRY
- do test
Contribution licence: All contributions are considered to be under same license as this repository.
๐งช Testing
Testing suite: ๐ Jest | Test command: npm test
Mutation testing suite: ๐ฝ Stryker Mutator | Mutation test command: npm run mutation
If you intend to develop further or contribute code, then please ensure to write and use testing. Strive for 100% code coverage and high mutation scores. Mutation score 100 is great, but it's not always neccessary (if there are valid reasons).