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

Clean up docs slightly

Browse Source
This commit is contained in:
Schuyler Cebulskie
2017-01-07 03:29:52 -05:00
parent 8cff77726a
commit add3c1a8ee
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/util/Snowflake.js
View File

@@ -17,12 +17,12 @@ class Snowflake {
* 000000111011000111100001101001000101000000 00001 00000 000000000000 * 000000111011000111100001101001000101000000 00001 00000 000000000000
* number of ms since discord epoch worker pid increment * number of ms since discord epoch worker pid increment
* ``` * ```
* Note: this generator hardcodes the worker id as 1 and the process id as 0
* @typedef {string} Snowflake * @typedef {string} Snowflake
*/ */
/** /**
* Generate a Discord snowflake * Generates a Discord snowflake
* <info>This hardcodes the worker ID as 1 and the process ID as 0.</info>
* @returns {Snowflake} The generated snowflake * @returns {Snowflake} The generated snowflake
*/ */
static generate() { static generate() {
@@ -35,14 +35,14 @@ class Snowflake {
* A deconstructed snowflake * A deconstructed snowflake
* @typedef {Object} DeconstructedSnowflake * @typedef {Object} DeconstructedSnowflake
* @property {Date} date Date in the snowflake * @property {Date} date Date in the snowflake
* @property {number} workerID Worker id in the snowflake * @property {number} workerID Worker ID in the snowflake
* @property {number} processID Process id in the snowflake * @property {number} processID Process ID in the snowflake
* @property {number} increment Increment in the snowflake * @property {number} increment Increment in the snowflake
* @property {string} binary Binary representation of the snowflake * @property {string} binary Binary representation of the snowflake
*/ */
/** /**
* Deconstruct a Discord snowflake * Deconstructs a Discord snowflake
* @param {Snowflake} snowflake Snowflake to deconstruct * @param {Snowflake} snowflake Snowflake to deconstruct
* @returns {DeconstructedSnowflake} Deconstructed snowflake * @returns {DeconstructedSnowflake} Deconstructed snowflake
*/ */