short-uuid

What is short-uuid?

The short-uuid npm package is a utility for generating and working with short, URL-friendly UUIDs. It provides a way to encode and decode UUIDs into shorter formats, making them more suitable for use in URLs, database keys, and other contexts where a shorter identifier is beneficial.

What are short-uuid's main functionalities?

Generate Short UUID

This feature allows you to generate a new short UUID. The `short()` function creates a new translator instance, and `translator.new()` generates a new short UUID.

const short = require('short-uuid');
const translator = short();
const shortUUID = translator.new();
console.log(shortUUID);

Translate UUID to Short UUID

This feature allows you to convert a standard UUID to a short UUID. The `translator.fromUUID(uuid)` method takes a standard UUID and returns its shorter version.

const short = require('short-uuid');
const translator = short();
const uuid = '123e4567-e89b-12d3-a456-426614174000';
const shortUUID = translator.fromUUID(uuid);
console.log(shortUUID);

Translate Short UUID to UUID

This feature allows you to convert a short UUID back to a standard UUID. The `translator.toUUID(shortUUID)` method takes a short UUID and returns the original standard UUID.

const short = require('short-uuid');
const translator = short();
const shortUUID = 'SOME_SHORT_UUID';
const uuid = translator.toUUID(shortUUID);
console.log(uuid);

Custom Alphabet

This feature allows you to create a translator with a custom alphabet. The `short('0123456789abcdef')` function creates a new translator instance that uses the specified alphabet for encoding.

const short = require('short-uuid');
const customTranslator = short('0123456789abcdef');
const shortUUID = customTranslator.new();
console.log(shortUUID);

Other packages similar to short-uuid

uuid

The uuid package is a popular library for generating RFC4122 UUIDs. Unlike short-uuid, it does not provide functionality for shortening UUIDs, but it is widely used for generating standard UUIDs in various versions (v1, v3, v4, v5).

nanoid

Nanoid is a small, secure, URL-friendly unique string ID generator. It is similar to short-uuid in that it generates shorter IDs suitable for URLs, but it does not focus on translating standard UUIDs to shorter formats and vice versa.

cuid

Cuid is a collision-resistant ID generator optimized for horizontal scaling and performance. It generates short, readable IDs that are URL-friendly, similar to short-uuid, but it does not provide translation between standard UUIDs and short UUIDs.

README

short-uuid

Generate and translate standard UUIDs into shorter - or just different - formats and back.

v2.3.2

short-uuid provides RFC4122 v4-compliant UUIDs, thanks to uuid.

It includes Browserify support for client-side use as proposed by voronianski, with compiled browser-ready files in the npm package for convenience. The library is exposed as ShortUUID.

2.3.0 corrects Snyk vulnerability protection to a dev dependency. 2.3.1 merges the 2.1.x fixes into version history. 2.3.2 merges a TypeScript definition from alexturek.

v2.2.0 Deprecated

2.2.0 incorrectly added Snyk as a production dependency. It has been deprecated.

var short = require('short-uuid');
var translator = short(); // Defaults to flickrBase58
var decimalTranslator = short("0123456789"); // Provide a specific alphabet for translation
var cookieTranslator = short(short.constants.cookieBase90); // Use a constant for translation

// Generate a shortened v4 UUID
translator.new();

// Generate plain UUIDs
short.uuid(); // From the constructor without creating a translator
translator.uuid(); // Each translator provides the uuid.v4() function

// Translate UUIDs
translator.toUUID(shortId);
translator.fromUUID(regularUUID);

// See the alphabet used by a translator
translator.alphabet

// View the constants
short.constants.flickrBase58;
short.constants.cookieBase90;

v2.3.1 is under 1K when compressed. Using Browserify, the library and dependencies are ~3.2K.

Please see Revisions for information on previous versions.

Changelog

[2.3.2] - 2017-05-16

Added

• Added [index.d.ts] TypeScript definitions. No code changes.

Changed

• Changed [package.json] to reference TypeScript definitions