About 📘

This repository households the source code for the McEvert Snowflake package. We utilize Twitter's snowflake ❄️ format for uniquely identifiable descriptors (IDs).

$3

Snowflake IDs are 64-bit unsigned integers that are roughly sortable by time. Because of their length, snowflakes are always stored as strings. Snowflakes are composed of 4 parts:

- Timestamp, milliseconds since 1 January 2023 00:00:00 UTC
- Internal worker ID
- Internal process ID
- Increment, for every ID that is generated on that process

Installation 📦

``bash


With npm

`ts
import Snowflake from '@mcevert/snowflake';

const snowflake = new Snowflake();

// You can use this ID variable to identify a user, a message, a channel, etc.
const id = snowflake.generate();
`

$3

You can also parse existing snowflakes. This is useful when you want more information about a snowflake ID.

`ts
import Snowflake from '@mcevert/snowflake';

const snowflakeInfo = Snowflake.parse('131557566537793536');
// {
// createdAt: 2023-01-01T00:00:00.000Z,
// workerId: 0,
// processId: 0
// }
``

License 📜

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.