Package Exports

short-unique-id

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (short-unique-id) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Short Unique ID (UUID) Generating Library

Available for

Documentation with Online Short UUID Generator

You can find the docs and online generator at:

https://shortunique.id

What is the probability of generating the same id again?

This largely depends on the given dictionary and the selected UUID length.

Out of the box this library provides a shuffled dictionary of digits from 0 to 9, as well as the alphabet from a to z both in UPPER and lower case, with a default UUID length of 6. That gives you a total of 56,800,235,584 possible UUIDs.

So, given the previous values, the probability of generating a duplicate in 1,000,000 rounds is ~0.00000002, or about 1 in 50,000,000.

If you change the dictionary and/or the UUID length then we have provided the function collisionProbability() function to calculate the probability of hitting a duplicate in a given number of rounds (a collision) and the function uniqueness() which provides a score (from 0 to 1) to rate the "quality" of the combination of given dictionary and UUID length (the closer to 1, higher the uniqueness and thus better the quality).

To find out more about the math behind these functions please refer to the API Reference.

V3.x

Version 3.0 is a re-write of this library aiming to use Deno as the driving force of the development and distribution of Short Unique ID.

We did this by separating the Deno compatible typescript logic into a git submodule which gets bundled for the rest of the platforms by the scripts within the package.json in this repo.

Another reason for the re-write was to define a new license for the source code within this repo, the Apache 2.0 license.

"Deno" who? what?

Ryan Dahl, creator of Node.js, has spent the last couple of years working on Deno, a new runtime for JavaScript that is supposed to fix all the inherent problems of Node.

We have tried it out and are convinced that Deno is stable enough and delivers on all expectations we could have.

For more info check out this detailed look at Deno from LogRocket's blog.

Acknowledgement and platform support

This repo and npm package started as a straight up manual transpilation to ES6 of the short-uid npm package by Ankit Kuwadekar.

image depicting over 5000 weekly npm downloads

Since this package is now reporting between 4k and 5k+ npm weekly downloads, we've gone ahead and re-written the whole of it in TypeScript and made sure to package lib and dist modules compatible with Deno, Node.js and all major Browsers.

Development

Clone this repo (including submodules):

# SSH
git clone --recurse-submodules git@github.com:jeanlescure/short-unique-id.git

# HTTPS
git clone --recurse-submodules https://github.com/jeanlescure/short-unique-id.git

Tests run using Deno: