uuniq

Contents

• About
• Features
• Installation
• Documentation
  • Tree
  • Import
  • Constructors
  • Methods
  • Types
• Links
  • Discord
  • Telegram
  • Twitter
  • GitHub
• License

About

Short but unique IDs.

Features

• Short but unique IDs
• The possibility of collision is impossible
• Suitable for distributed systems
• Suitable for sorting and database indexes
• Snowflake IDs developed by Twitter (X) can be generated
• Symbolic IDs can be generated like YouTube's video IDs

Installation

You can install it as follows.

// NPM
npm install uuniq

// PNPM
pnpm install uuniq

// Yarn
yarn add uuniq

// Bun
bun add uuniq

// Deno
deno install npm:uuniq

Documentation

Tree

Briefly as follows.

Uuniq
│
├── new Snowflake(options?)
│   │
│   ├── generate()
│   └── resolve(id)
│
├── new Symbolic(options?)
│   │
│   ├── generate()
│   └── resolve(id)
│
└── type Types
    │
    ├── SnowflakeOptions
    ├── SnowflakeResolve
    ├── SymbolicOptions
    └── SymbolicResolve

Import

Briefly as follows.

TypeScript

import { Snowflake, Symbolic, type Types as UuniqTypes } from "uuniq";

JavaScript

import { Snowflake, Symbolic } from "uuniq";

Constructors

new Snowflake(options?)

Snowflake IDs developed by Twitter (X) in 2010. Unique IDs can be generated in distributed systems by specifying Place IDs.

Parameter	Default	Description
options	SnowflakeOptionsDefault	SnowflakeOptions (optional) Constructor's options.

Example:

const SnowflakeIDs: Snowflake = new Snowflake();

new Symbolic(options?)

Unique IDs like YouTube's video IDs. Unique IDs can be generated in distributed systems by specifying Place IDs.

Parameter	Default	Description
options	SymbolicOptionsDefault	SymbolicOptions (optional) Constructor's options.

Example:

const SymbolicIDs: Symbolic = new Symbolic();

Methods

Snowflake.generate()

Generate Snowflake IDs developed by Twitter (X) in 2010.

Parameter	Default	Description

returns String

Example:

SnowflakeIDs.generate(); // "102604921389056"
SnowflakeIDs.generate(); // "102604921389057"

Snowflake.resolve(id)

Resolve the previously created ID. For this, the epoch and place_id values ​​in the Constructor must be correct.

Parameter	Default	Description
id		String ID to be resolved.

returns SnowflakeResolve

Example:

SnowflakeIDs.resolve("102604921389056");
/*
  {
    created_at: "2025-03-14T11:35:07.409Z",
    place_id: 0,
    sequence: 0
  }
*/

Symbolic.generate()

Generate unique IDs like YouTube's video IDs.

Parameter	Default	Description

returns String

Example:

SymbolicIDs.generate(); // "T8Qu56ki"
SymbolicIDs.generate(); // "T8Qu56kj"

Symbolic.resolve(id)

Resolve the previously created ID. For this, the epoch and place_id values ​​in the Constructor must be correct.

Parameter	Default	Description
id		String ID to be resolved.

returns SymbolicResolve

Example:

SymbolicIDs.resolve("T8Qu56ki");
/*
  {
    created_at: "2025-03-14T11:36:05.528Z",
    place_id: 0,
    sequence: 0
  }
*/

Types

Type
SnowflakeOptions
SnowflakeResolve
SymbolicOptions
SymbolicResolve

Links

• Discord
• Telegram
• Twitter
• GitHub

License

MIT License

Copyright (c) 2025 Keift

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.