Contents

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

About

Short yet unique IDs.

Features

• Short yet 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
• Increment IDs that only increase when generated
• Symbolic IDs can be generated like YouTube's video IDs

Installation

You can install it as follows.

// NPM
npm add uuniq

// PNPM
pnpm add uuniq

// Yarn
yarn add uuniq

// Bun
bun add uuniq

// Deno
deno add uuniq

Documentation

Tree

Briefly as follows.

Uuniq
│
├── new Snowflake(options?)
│   │
│   ├── generate()
│   └── resolve(id)
│
├── new Increment(options)
│   │
│   └── generate()
│
├── type SnowflakeOptions
├── type SnowflakeResolve
└── type IncrementOptions

Import

Briefly as follows.

import { Snowflake, Increment } 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 = new Snowflake();

new Increment(options)

Unique IDs that only increase when generated. Sequences are kept in the database. You can create a free database from MongoDB Cloud. Storing sequences requires tools that include set(key, value) and get(key). We recommend Keyv. Sequences can be parsed by specifying Place IDs.

| Parameter | Default | Description | | --------- | ------------------------- | --------------------------------------------- | | options | IncrementOptionsDefault | IncrementOptionsConstructor's options. |

Example:

import Keyv from 'keyv';
import KeyvMongo from '@keyv/mongo';

const UuniqStore = new Keyv(new KeyvMongo('mongodb+srv://[email protected]/app', { collection: 'uuniq' }));
const IncrementIDs = new Increment({ store: UuniqStore });

Methods

Snowflake.generate()

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

| Parameter | Default | Description | | --------- | ------- | ----------- | | | | |

returns String

Example:

const NumericSnowflakeIDs = new Snowflake({ format: 'numeric' });
const SymbolicSnowflakeIDs = new Snowflake({ format: 'symbolic' });

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

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

Snowflake.resolve(id)

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

| Parameter | Default | Description | | --------- | ------- | -------------------------------- | | id | | String ID to be resolved. |

returns SnowflakeResolve

Example:

const NumericSnowflakeIDs = new Snowflake({ format: 'numeric' });
const SymbolicSnowflakeIDs = new Snowflake({ format: 'symbolic' });

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

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

Increment.generate()

Generate unique IDs that only increase when generated.

| Parameter | Default | Description | | --------- | ------- | ----------- | | | | |

returns Promise<String>

Example:

const NumericIncrementIDs = new Increment({ format: 'numeric', store: UuniqStore });
const SymbolicIncrementIDs = new Increment({ format: 'symbolic', store: UuniqStore });

await NumericIncrementIDs.generate(); // "10000001"
await NumericIncrementIDs.generate(); // "10000002"

await SymbolicIncrementIDs.generate(); // "fxSL"
await SymbolicIncrementIDs.generate(); // "fxSM"

Types

| Type | | ------------------ | | SnowflakeOptions | | SnowflakeResolve | | IncrementOptions |

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.