docs: fix a typo and use milliseconds instead of ms (#7251)

This commit is contained in:
Vitor
2022-01-13 16:59:28 +00:00
committed by GitHub
parent 7b53978a73
commit 0dd56afe1c
5 changed files with 6 additions and 6 deletions

View File

@@ -533,7 +533,7 @@ module.exports = Client;
* ``` * ```
* 64 22 17 12 0 * 64 22 17 12 0
* 000000111011000111100001101001000101000000 00001 00000 000000000000 * 000000111011000111100001101001000101000000 00001 00000 000000000000
* number of ms since Discord epoch worker pid increment * number of milliseconds since Discord epoch worker pid increment
* ``` * ```
* @typedef {string} Snowflake * @typedef {string} Snowflake
*/ */

View File

@@ -15,7 +15,7 @@ class RateLimitError extends Error {
this.name = 'RateLimitError'; this.name = 'RateLimitError';
/** /**
* Time until this rate limit ends, in ms * Time until this rate limit ends, in milliseconds
* @type {number} * @type {number}
*/ */
this.timeout = timeout; this.timeout = timeout;

View File

@@ -280,7 +280,7 @@ class RequestHandler {
/** /**
* @typedef {Object} InvalidRequestWarningData * @typedef {Object} InvalidRequestWarningData
* @property {number} count Number of invalid requests that have been made in the window * @property {number} count Number of invalid requests that have been made in the window
* @property {number} remainingTime Time in ms remaining before the count resets * @property {number} remainingTime Time in milliseconds remaining before the count resets
*/ */
/** /**

View File

@@ -5,7 +5,7 @@ const process = require('node:process');
/** /**
* Rate limit data * Rate limit data
* @typedef {Object} RateLimitData * @typedef {Object} RateLimitData
* @property {number} timeout Time until this rate limit ends, in ms * @property {number} timeout Time until this rate limit ends, in milliseconds
* @property {number} limit The maximum amount of requests of this endpoint * @property {number} limit The maximum amount of requests of this endpoint
* @property {string} method The HTTP method of this request * @property {string} method The HTTP method of this request
* @property {string} path The path of the request relative to the HTTP endpoint * @property {string} path The path of the request relative to the HTTP endpoint
@@ -66,7 +66,7 @@ const process = require('node:process');
* @property {PresenceData} [presence={}] Presence data to use upon login * @property {PresenceData} [presence={}] Presence data to use upon login
* @property {IntentsResolvable} intents Intents to enable for this connection * @property {IntentsResolvable} intents Intents to enable for this connection
* @property {number} [waitGuildTimeout=15_000] Time in milliseconds that Clients with the GUILDS intent should wait for * @property {number} [waitGuildTimeout=15_000] Time in milliseconds that Clients with the GUILDS intent should wait for
* missing guilds to be recieved before starting the bot. If not specified, the default is 15 seconds. * missing guilds to be received before starting the bot. If not specified, the default is 15 seconds.
* @property {SweeperOptions} [sweepers={}] Options for cache sweeping * @property {SweeperOptions} [sweepers={}] Options for cache sweeping
* @property {WebsocketOptions} [ws] Options for the WebSocket * @property {WebsocketOptions} [ws] Options for the WebSocket
* @property {HTTPOptions} [http] HTTP options * @property {HTTPOptions} [http] HTTP options

View File

@@ -155,7 +155,7 @@ export interface InvalidRequestWarningData {
*/ */
count: number; count: number;
/** /**
* Time in ms remaining before the count resets * Time in milliseconds remaining before the count resets
*/ */
remainingTime: number; remainingTime: number;
} }