From 363cec31bcc2caa057f1ad967f964dcd842b719a Mon Sep 17 00:00:00 2001 From: anandre <38661761+anandre@users.noreply.github.com> Date: Wed, 15 May 2019 15:33:27 -0500 Subject: [PATCH] docs(TextChanne): specify unit of rateLimitPerUser (#3272) * Update TextChannel.js Update `setRateLimitPerUser` description to specify the `number` is in seconds, per the Discord docs * Update TextChannel.js Add unit to the rateLimitPerUser property * Update GuildChannel.js --- src/structures/GuildChannel.js | 2 +- src/structures/TextChannel.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index d95de1d83..eb470a868 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -286,7 +286,7 @@ class GuildChannel extends Channel { * @property {CategoryChannel|Snowflake} [parent] The parent or parent ID of the channel * @property {ChannelCreationOverwrites[]|Collection} [permissionOverwrites] * Overwrites of the channel - * @property {number} [rateLimitPerUser] The rate limit per user of the channel + * @property {number} [rateLimitPerUser] The rate limit per user of the channel in seconds */ /** diff --git a/src/structures/TextChannel.js b/src/structures/TextChannel.js index c47ba6d1a..d16dac87d 100644 --- a/src/structures/TextChannel.js +++ b/src/structures/TextChannel.js @@ -48,7 +48,7 @@ class TextChannel extends GuildChannel { this.lastPinTimestamp = data.last_pin_timestamp ? new Date(data.last_pin_timestamp).getTime() : null; /** - * The ratelimit per user for this channel + * The ratelimit per user for this channel in seconds * @type {number} */ this.rateLimitPerUser = data.rate_limit_per_user || 0; @@ -115,7 +115,7 @@ class TextChannel extends GuildChannel { /** * Sets the rate limit per user for this channel. - * @param {number} rateLimitPerUser The new ratelimit + * @param {number} rateLimitPerUser The new ratelimit in seconds * @param {string} [reason] Reason for changing the channel's ratelimits * @returns {Promise} */