https://github.com/keift/uuniq
Unique Snowflake IDs and Symbolic IDs that can be generated for thousands of years.
https://github.com/keift/uuniq
id snowflake snowflake-id symbolic symbolic-id unique unique-id
Last synced: 6 months ago
JSON representation
Unique Snowflake IDs and Symbolic IDs that can be generated for thousands of years.
- Host: GitHub
- URL: https://github.com/keift/uuniq
- Owner: keift
- License: mit
- Created: 2025-03-01T02:07:04.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T01:13:55.000Z (6 months ago)
- Last Synced: 2025-04-01T01:15:13.342Z (6 months ago)
- Topics: id, snowflake, snowflake-id, symbolic, symbolic-id, unique, unique-id
- Language: JavaScript
- Homepage:
- Size: 166 KB
- Stars: 8
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[Function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function
[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
[String]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String
[Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number
[Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date
[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
[Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[Buffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer
[Void]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Undefined
## Contents
- [About](#about)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Links](#links)
- [Change Log](CHANGELOG.md)
## About
Unique Snowflake IDs and Symbolic IDs that can be generated for thousands of years.
## Features
* 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
* Shorter IDs can be generated like YouTube's video IDs
## Installation
NPM
```sh-session
npm install uuniq
```
PNPM
```sh-session
pnpm install uuniq
```
Yarn
```sh-session
yarn add uuniq
```
Bun
```sh-session
bun add uuniq
```
Deno
```sh-session
deno install npm:uuniq
```
## Usage
Briefly as follows.
> ```javascript
> const Uuniq = require("uuniq");
> const Snowflake = new Uuniq.Snowflake();
> const Symbolic = new Uuniq.Symbolic();
>
> Snowflake.generate(); // "102604921389056"
> Snowflake.generate(); // "102604921389057"
>
> Snowflake.resolve("102604921389056");
> /*
> {
> created_at: "2025-03-14T11:35:07.409Z",
> place_id: 0,
> sequence: 0
> }
> */
>
> Symbolic.generate(); // "T8Qu56ki"
> Symbolic.generate(); // "T8Qu56kj"
>
> Symbolic.resolve("T8Qu56ki");
> /*
> {
> created_at: "2025-03-14T11:36:05.528Z",
> place_id: 0,
> sequence: 0
> }
> */
> ```
## Documentation
### Constructors
`new Snowflake(options?)`
Generate Snowflake IDs developed by Twitter (X) in 2010. This can generate IDs for approximately 4,463 years according to the specified epoch. Unique IDs can be generated in distributed systems by specifying Place IDs.
> | Parameter | Default | Description |
> | --- | --- | --- |
> | options | | [Object] (optional)
Constructor's options. |
> | options.epoch | `"2025-01-01T00:00:00.000Z"` | [String] \| [Number] \| [Date] (optional)
Date of epoch. |
> | options.place_id | `0` | [Number] (optional)
Place ID for distributed systems. |
>
> returns [Object]
>
>
> Example:
>
> ```js
> const Snowflake = new Uuniq.Snowflake({
> epoch: "2025-01-01T00:00:00.000Z",
> place_id: 0
> });
> ```
`new Symbolic(options?)`
Generate unique IDs like YouTube's video IDs. This can generate IDs for approximately 4,463 years according to the specified epoch. Unique IDs can be generated in distributed systems by specifying Place IDs.
> | Parameter | Default | Description |
> | --- | --- | --- |
> | options | | [Object] (optional)
Constructor's options. |
> | options.epoch | `"2025-01-01T00:00:00.000Z"` | [String] \| [Number] \| [Date] (optional)
Date of epoch. |
> | options.place_id | `0` | [Number] (optional)
Place ID for distributed systems. |
> | options.charset | `"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"` | [String] (optional)
Character set of IDs. |
>
> returns [Object]
>
>
> Example:
>
> ```js
> const Symbolic = new Uuniq.Symbolic({
> epoch: "2025-01-01T00:00:00.000Z",
> place_id: 0,
> charset: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
> });
> ```
### Methods
`Snowflake.generate()`
Generate Snowflake IDs developed by Twitter (X) in 2010. This can generate IDs for approximately 4,463 years according to the specified epoch.
> | Parameter | Default | Description |
> | --- | --- | --- |
> | | | |
>
> returns [String]
>
>
> Example:
>
> ```js
> Snowflake.generate(); // "102604921389056"
> Snowflake.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 [Object]
>
>
> Example:
>
> ```js
> Snowflake.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. This can generate IDs for approximately 4,463 years according to the specified epoch.
> | Parameter | Default | Description |
> | --- | --- | --- |
> | | | |
>
> returns [String]
>
>
> Example:
>
> ```js
> Symbolic.generate(); // "T8Qu56ki"
> Symbolic.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 [Object]
>
>
> Example:
>
> ```js
> Symbolic.resolve("T8Qu56ki");
> /*
> {
> created_at: "2025-03-14T11:36:05.528Z",
> place_id: 0,
> sequence: 0
> }
> */
> ```
## Links
- [Change Log](CHANGELOG.md)
## License
[MIT](LICENSE.md)