Git Product home page Git Product logo

sunbeam's Introduction

Sunbeam

An NodeJS distributed customizable ID generator inspired by Twitter's Snowflake

API

This module exports only one class - Sunbeam

constructor ( ?value : Number|String|Buffer|Sunbeam, ?unit : Number, ?epoch : Number )

  • value may be any supported format or undefined
  • unit by default is 1000ms
  • epoch by default is 01/01/2000 00:00:00:000

toBuffer ( )

toString ( )

toBigInt ( )

toNumber ( )

Methods to export Sunbeam

clone ( )

Self-explainatory method

[get/set] timestamp : Number <32bit>

[get/set] machineId : Number <12bit>

[get/set] sequenceId : Number <8bit>

[get/set] flipFlag : Number <1bit>

See Snowflake/Sonyflake/etc docs

static generate ( machineId, sequenceId, flipFlag, unit, epoch)

Create new Sunbeam with pre-filled params

static *createGenerator (machineId, unit, epoch)

Create Sunbeam IDs generator

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.