Generate and translate standard UUIDs into shorter - or just different - formats and back.
Major Changes in 4.0.0
- 🛑 short-uuid will now throw an error when provided an alphabet with duplicate characters. Duplicate characters will cause translation errors.
- ℹ️ 4.0.0 is written in modern ECMAScript. It uses features through ES9/ES2018.
- ℹ️ 4.x does not yet include the pre-built version for browsers. If needed, continue to use 3.1.1 in the meantime.
- ℹ️ By default, short-uuid will pad shortened IDs to a consistent length.
- Padding does not affect translation, and the values are compatible with previous releases.
- Padding can be disabled with the option
consistentLength: falsewhen instantiating a translator. This is consistent with previous versions.
const short = ;// Quick start with flickrBase58 formatshort; // 73WakrfVbNJBaAmhQtEeDv
short-uuid starts with RFC4122 v4-compliant UUIDs and translates them into other, usually shorter formats. It also provides translators to convert back and forth from RFC compliant UUIDs to the shorter formats.
As of 4.0.0, formats return consistent-length values unless specifically requested.
This is done by padding the start with the first (
) character in the alphabet.
Previous versions can translate padded formats back to UUID.
const short = ;const translator = ; // Defaults to flickrBase58const decimalTranslator = ; // Provide a specific alphabet for translationconst cookieTranslator = ; // Use a constant for translation// Generate a shortened v4 UUIDtranslator; // mhvXdrZT4jP5T8vBxuvm75translator; // An alias for new.// Translate UUIDs to and from the shortened formattranslator; // a44521d0-0fb8-4ade-8002-3385545c3318translator; // mhvXdrZT4jP5T8vBxuvm75// Generate plain UUIDs// - From the library without creating a translatorshort; // fd5c084c-ff7c-4651-9a52-37096242d81c// - Each translator provides the uuid.v4() function, tootranslator; // 3023b0f5-ec55-4e75-9cd8-104700698052// See the alphabet used by a translatortranslatoralphabet;// The maximum length a translated uuid will be with its alphabet.translatormaxLength;// View the constantsshortconstantsflickrBase58; // Avoids similar characters (0/O, 1/I/l, etc.)shortconstantscookieBase90; // Safe for HTTP cookies values for smaller IDs.
short-uuid 4.0.0 adds support for options when creating a translator. This will support additional configuration in the future.
const short = ;// By default shortened values are now padded for consistent length.// If you want to produce variable lengths, like in 3.1.1const translator =;// Generate a shortened v4 UUIDtranslator; // mhvXdrZT4jP5T8vBxuvm75
consistentLength- Controls padding on shortened values. Default is
short-uuid 4.0.0 and later is confirmed to work on Node 8.x and later.
- Pre-compiled browser version is planned for future release.
short-uuid provides RFC4122 v4-compliant UUIDs,
TypeScript definitions are included, thanks to alexturek.
Recent Release Notes
4.1.0 adds a maxLength value to translators for reference 4.0.3 fixes default generate 4.0.1 adds consistent length translation and throws an error if provided an invalid alphabet. 3.1.1 updated dev dependencies which required dropping Node 4.x build test. Last Browserify distribution version temporarily. 2.3.4 corrects the behavior for UUIDs with uppercase letters. Last version to build on Node 0.x.
Please see Revisions for information on previous versions.