Nine Putrid Mangos

    @sapphire/snowflake
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.2 • Public • Published

    Sapphire Logo

    @sapphire/snowflake

    Deconstruct and generate snowflake IDs using BigInts.

    GitHub codecov npm bundle size npm

    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 esbuild 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

    You can use the following command to install this package, or replace npm install with your package manager of choice.

    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');
    
    // 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');
    
    // 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');
    
    // 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');
    
    // Deconstruct a snowflake with Twitter's epoch
    const uniqueId = TwitterSnowflake.deconstruct('3971046231244935168');
    
    // Alternatively, you can use the method directly
    const uniqueId = TwitterSnowflake.deconstruct('3971046231244935168');

    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 With Address
    Open Collective Click Here
    Ko-fi Click Here
    Patreon Click Here
    PayPal Click Here

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Jeroen Claassens

    💻 🚇 📆 📖 ⚠️

    Antonio Román

    💻 📆 👀 ⚠️

    Gryffon Bellish

    💻 👀 ⚠️

    Vlad Frangu

    💻 🐛 👀 📓 ⚠️

    Stitch07

    💻 📆 ⚠️

    depfu[bot]

    🚧

    allcontributors[bot]

    📖

    Tyler J Russell

    📖

    Ivan Lieder

    💻 🐛

    Hezekiah Hendry

    💻

    Vetlix

    💻

    Ethan Mitchell

    📖

    Elliot

    💻

    Jurien Hamaker

    💻

    Charalampos Fanoulis

    📖

    dependabot[bot]

    🚧

    Kaname

    💻

    nandhagk

    🐛

    megatank58

    💻

    UndiedGamer

    💻

    Lioness100

    📖 💻

    David

    💻

    renovate[bot]

    🚧

    WhiteSource Renovate

    🚧

    FC

    💻

    Jérémy de Saint Denis

    💻

    MrCube

    💻

    bitomic

    💻

    c43721

    💻

    Commandtechno

    💻

    Aura

    💻

    Jonathan

    💻

    Parbez

    🚧

    Paul Andrew

    📖

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

    Install

    npm i @sapphire/snowflake

    DownloadsWeekly Downloads

    131,858

    Version

    3.2.2

    License

    MIT

    Unpacked Size

    69 kB

    Total Files

    13

    Last publish

    Collaborators

    • favna
    • kyranet
    • vladfrangu