README
Snowyflake - A modern implementation Snowflake on TypeScript
📖 Documentation |
---|
Installation
Node.js 16.0.0 or newer is required
TypeScript config required
"targer": "ES2019"
or higher
Yarn
Recommended
yarn add snowyflake
NPM
npm i snowyflake
Example usage
import { Snowyflake, Epoch } from 'snowyflake';
const snowyflake = new Snowyflake({
workerId: 1n,
epoch: Epoch.Twitter // BigInt timestamp
});
const snowflake = snowyflake.nextId();
console.log(snowflake); // => 1075766315999952896n
const deconstructSnowflake = snowyflake.deconstruct(snowflake);
console.log(deconstructSnowflake); // =>
// { timestamp: 1545317651163n,
// workerId: 1n,
// processId: 0n,
// sequence: 0n }