3.5.4 • Published 10 months ago

@sapphire/snowflake v3.5.4

Weekly downloads
115
License
MIT
Repository
github
Last release
10 months ago

Sapphire Logo

@sapphire/snowflake

Deconstruct and generate snowflake IDs using BigInts.

GitHub codecov npm bundle size npm Depfu

Table of Contents

Description

There is often a need to get a unique ID for entities, be that for Discord messages/channels/servers, keys in a database or many other similar examples. There are many ways to get such a unique ID, and one of those is using a so-called "snowflake". You can read more about snowflake IDs in this Medium article.

Features

  • Written in TypeScript
  • Bundled with Rollup so it can be used in NodeJS and browsers
  • Offers CommonJS, ESM and UMD bundles
  • Offers predefined epochs for Discord and Twitter
  • Fully tested

Installation

yarn add @sapphire/snowflake
# npm install @sapphire/snowflake

Usage

Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { Snowflake } = require('@sapphire/snowflake') equals import { Snowflake } from '@sapphire/snowflake'.

Constructing snowflakes

Snowflakes with custom epoch

// Import the Snowflake class
const { Snowflake } = require('@sapphire/snowflake');

// Define a custom epoch
const epoch = new Date('2000-01-01T00:00:00.000Z');

// Create an instance of Snowflake
const snowflake = new Snowflake(epoch);

// Generate a snowflake with the given epoch
const uniqueId = snowflake.generate();

Snowflake with Discord epoch constant

// Import the Snowflake class
const { DiscordSnowflake } = require('@sapphire/snowflake');

// Create an instance of Snowflake
const discordSnowflake = new DiscordSnowflake();

// Generate a snowflake with Discord's epoch
const uniqueId = discordSnowflake.generate();

// Alternatively, you can use the method directly
const uniqueId = DiscordSnowflake.generate();

Snowflake with Twitter epoch constant

// Import the Snowflake class
const { TwitterSnowflake } = require('@sapphire/snowflake');

// Create an instance of Snowflake
const twitterSnowflake = new TwitterSnowflake();

// Generate a snowflake with Twitter's epoch
const uniqueId = twitterSnowflake.generate();

// Alternatively, you can use the method directly
const uniqueId = TwitterSnowflake.generate();

Deconstructing snowflakes

Snowflakes with custom epoch

// Import the Snowflake class
const { Snowflake } = require('@sapphire/snowflake');

// Define a custom epoch
const epoch = new Date('2000-01-01T00:00:00.000Z');

// Create an instance of Snowflake
const snowflake = new Snowflake(epoch);

// Deconstruct a snowflake with the given epoch
const uniqueId = snowflake.deconstruct('3971046231244935168');

Snowflake with Discord epoch constant

// Import the Snowflake class
const { DiscordSnowflake } = require('@sapphire/snowflake');

// Create an instance of Snowflake
const discordSnowflake = new DiscordSnowflake();

// Deconstruct a snowflake with Discord's epoch
const uniqueId = discordSnowflake.deconstruct('3971046231244935168');

// Alternatively, you can use the method directly
const uniqueId = DiscordSnowflake.deconstruct('3971046231244935168');

Snowflake with Twitter epoch constant

// Import the Snowflake class
const { TwitterSnowflake } = require('@sapphire/snowflake');

// Create an instance of Snowflake
const twitterSnowflake = new TwitterSnowflake();

// Deconstruct a snowflake with Twitter's epoch
const uniqueId = twitterSnowflake.deconstruct('3971046231244935168');

// Alternatively, you can use the method directly
const uniqueId = TwitterSnowflake.deconstruct('3971046231244935168');

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

3.5.4-next.bb6c8891

10 months ago

3.5.4-next.0cb1b7f1

10 months ago

3.5.5-next.79db3048

10 months ago

3.5.5-next.8490b4d9

10 months ago

3.5.4

10 months ago

3.5.4-next.09afdaab

10 months ago

3.5.4-next.78b93032

10 months ago

3.5.4-next.143375f7

10 months ago

3.5.5-next.9b2d985c

10 months ago

3.5.4-next.ba915f93

10 months ago

3.5.4-next.4b7c3e6c

10 months ago

3.5.5-next.24be195f

10 months ago

3.5.5-next.624d18f9

10 months ago

3.5.4-next.d8701971

10 months ago

3.5.4-next.78c5a5bb

10 months ago

3.5.4-next.d8c5d05d

10 months ago

3.5.4-next.72e50e85

10 months ago

3.5.4-next.0dce7d63

10 months ago

3.5.4-next.a6c8ccda

10 months ago

3.5.4-next.5ac3f246

10 months ago

3.5.4-next.403a3afe

10 months ago

3.5.4-next.1e7d2dec

10 months ago

3.5.4-next.74c9ef24

11 months ago

3.5.4-next.70feaf69

11 months ago

3.5.4-next.809c41ce

11 months ago

3.5.4-next.acf54294

11 months ago

3.5.4-next.caddeb87

10 months ago

3.5.4-next.b913810f

11 months ago

3.5.4-next.19790b8e

11 months ago

3.5.4-next.a133f01a

11 months ago

3.5.4-next.8627eb32

11 months ago

3.5.4-next.574c09c3

11 months ago

3.5.4-next.b97b30cd

12 months ago

3.5.4-next.fc35dd86

12 months ago

3.5.4-next.86dab688

12 months ago

3.5.4-next.6100b95e

12 months ago

3.5.4-next.855b323f

12 months ago

3.5.4-next.63feeab8

12 months ago

3.5.4-next.4a5bf954

12 months ago

3.5.4-next.8810833c

12 months ago

3.5.4-next.f3243e67

12 months ago

3.5.4-next.5c8eaf07

12 months ago

3.5.4-next.1ac67e71

12 months ago

3.5.4-next.98befbf8

12 months ago

3.5.3

2 years ago

3.5.2

2 years ago

3.5.1

2 years ago

3.5.0

2 years ago

3.4.3

2 years ago

3.4.2

2 years ago

3.4.1

2 years ago

3.4.0

3 years ago

3.3.0

3 years ago

3.2.2

3 years ago

3.2.1

3 years ago

3.2.0

3 years ago

3.1.0

4 years ago

3.0.1

4 years ago

3.0.0

4 years ago

2.1.4

4 years ago

2.1.3

4 years ago

2.1.2

4 years ago

2.1.1

4 years ago

2.1.0

4 years ago

2.0.0

4 years ago

1.3.6

4 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

4 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.8

4 years ago

1.2.7

4 years ago

1.2.6

4 years ago

1.2.5

5 years ago

1.2.4

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago