Skip to content

Commit

Permalink
docs: fix a typo and use milliseconds instead of ms (#7251)
Browse files Browse the repository at this point in the history
  • Loading branch information
vvito7 committed Jan 13, 2022
1 parent 7b53978 commit 0dd56af
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion packages/discord.js/src/client/Client.js
Expand Up @@ -533,7 +533,7 @@ module.exports = Client;
* ```
* 64 22 17 12 0
* 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
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/discord.js/src/rest/RateLimitError.js
Expand Up @@ -15,7 +15,7 @@ class RateLimitError extends Error {
this.name = 'RateLimitError';

/**
* Time until this rate limit ends, in ms
* Time until this rate limit ends, in milliseconds
* @type {number}
*/
this.timeout = timeout;
Expand Down
2 changes: 1 addition & 1 deletion packages/discord.js/src/rest/RequestHandler.js
Expand Up @@ -280,7 +280,7 @@ class RequestHandler {
/**
* @typedef {Object} InvalidRequestWarningData
* @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
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions packages/discord.js/src/util/Options.js
Expand Up @@ -5,7 +5,7 @@ const process = require('node:process');
/**
* Rate limit data
* @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 {string} method The HTTP method of this request
* @property {string} path The path of the request relative to the HTTP endpoint
Expand Down Expand Up @@ -66,7 +66,7 @@ const process = require('node:process');
* @property {PresenceData} [presence={}] Presence data to use upon login
* @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
* 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 {WebsocketOptions} [ws] Options for the WebSocket
* @property {HTTPOptions} [http] HTTP options
Expand Down
2 changes: 1 addition & 1 deletion packages/rest/src/lib/REST.ts
Expand Up @@ -155,7 +155,7 @@ export interface InvalidRequestWarningData {
*/
count: number;
/**
* Time in ms remaining before the count resets
* Time in milliseconds remaining before the count resets
*/
remainingTime: number;
}
Expand Down

0 comments on commit 0dd56af

Please sign in to comment.