uuid

Locally ordered UUID generator

🧭 Table of contents

• ✨ Benefits
• 🎒 Requierments
• 🚀 Quickstart
• 📘 Documentation
• 🆘 Troubleshooting
• 🤝 Contributing
• 🧪 Testing
• ⚖️ License

✨ Benefits

• [x] Ordered locally - compatible with Array.sort()
• [x] Math.random() is used (+ speed, - pseudorandom)
• [x] Total length 32
• [x] Each character is 32 bit based on base32hex
• [x] First 9 charaters for timestamp (max. 12 December 3084)
• [x] 5 characters for counter max. 33 554 432 per milisecond
• [x] 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).

⚖️ License

MIT License