v5.2.0

Major Changes in 5.0.0

Quick Start

constshort=require('short-uuid');// Quick start with flickrBase58 formatshort.generate();// '73WakrfVbNJBaAmhQtEeDv'

Details

constshort=require('short-uuid');// Generate a flickrBase58 short ID from without creating a translatorconstshortId=short.generate();consttranslator=short();// Defaults to flickrBase58constdecimalTranslator=short("0123456789");// Provide a specific alphabet for translationconstcookieTranslator=short(short.constants.cookieBase90);// Use a constant for translation// Generate a shortened v4 UUIDtranslator.new();// mhvXdrZT4jP5T8vBxuvm75translator.generate();// An alias for new.// Translate UUIDs to and from the shortened formattranslator.toUUID(shortId);// a44521d0-0fb8-4ade-8002-3385545c3318translator.fromUUID(regularUUID);// mhvXdrZT4jP5T8vBxuvm75// Check if a string is a valid ID (length and alphabet)translator.validate(shortId);// true// Check if a string is valid *AND* translates to a valid UUIDtranslator.validate(shortId,true);// truetranslator.validate('0000000000000000000000',true)// false// See the alphabet used by a translatortranslator.alphabet;// The maximum length a translated uuid will be with its alphabet.// if consistentLength is set (on by default), so ids will be this length.translator.maxLength;// View the constantsshort.constants.cookieBase90;// Safe for HTTP cookies values for smaller IDs.short.constants.flickrBase58;// Avoids similar characters (0/O, 1/I/l, etc.)short.constants.uuid25Base36;// The uuid25 (string length 25) format// Generate plain UUIDs// - From the library without creating a translatorshort.uuid();// fd5c084c-ff7c-4651-9a52-37096242d81c// - Each translator provides the uuid.v4() function, tootranslator.uuid();// 3023b0f5-ec55-4e75-9cd8-104700698052

Options

constshort=require('short-uuid');// By default shortened values are now padded for consistent length.// If you want to produce variable lengths, like in 3.1.1consttranslator=short(short.constants.flickrBase58,{consistentLength:false,});// Generate a shortened v4 UUIDtranslator.new();// mhvXdrZT4jP5T8vBxuvm75

Support

Notes

Previous Release Note Highlights