Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 09:03:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Detardify snowflake docs/organisation

Browse Source
This commit is contained in:
Schuyler Cebulskie
2017-01-07 03:22:55 -05:00
parent a66b2b7ec5
commit 8cff77726a
1 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
src/util/Snowflake.js
View File

@@ -4,20 +4,10 @@ const Long = require('long');
const EPOCH = 1420070400000;
let INCREMENT = 0;
function pad(v, n, c = '0') {
return String(v).length >= n ? String(v) : (String(c).repeat(n) + v).slice(-n);
}
/**
* A deconstructed snowflake
* @typedef {Object} DeconstructedSnowflake
* @property {Date} date Date in the snowflake
* @property {number} workerID Worker id in the snowflake
* @property {number} processID Process id in the snowflake
* @property {number} increment Increment in the snowflake
* @property {string} binary Binary representation of the snowflake
*/
/**
* A container for useful snowflake-related methods
*/
class Snowflake {
/**
* A Twitter snowflake, except the epoch is 2015-01-01T00:00:00.000Z
* ```
@@ -29,9 +19,8 @@ function pad(v, n, c = '0') {
* ```
* Note: this generator hardcodes the worker id as 1 and the process id as 0
* @typedef {string} Snowflake
* @class Snowflake
*/
class Snowflake {
/**
* Generate a Discord snowflake
* @returns {Snowflake} The generated snowflake
@@ -42,6 +31,16 @@ class Snowflake {
return Long.fromString(BINARY, 2).toString();
}
/**
* A deconstructed snowflake
* @typedef {Object} DeconstructedSnowflake
* @property {Date} date Date in the snowflake
* @property {number} workerID Worker id in the snowflake
* @property {number} processID Process id in the snowflake
* @property {number} increment Increment in the snowflake
* @property {string} binary Binary representation of the snowflake
*/
/**
* Deconstruct a Discord snowflake
* @param {Snowflake} snowflake Snowflake to deconstruct
@@ -59,4 +58,8 @@ class Snowflake {
}
}
function pad(v, n, c = '0') {
return String(v).length >= n ? String(v) : (String(c).repeat(n) + v).slice(-n);
}
module.exports = Snowflake;