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
This commit is contained in:
anandre
2019-05-15 15:33:27 -05:00
committed by SpaceEEC
parent c844a7b4e2
commit 363cec31bc
2 changed files with 3 additions and 3 deletions

View File

@@ -286,7 +286,7 @@ class GuildChannel extends Channel {
* @property {CategoryChannel|Snowflake} [parent] The parent or parent ID of the channel
* @property {ChannelCreationOverwrites[]|Collection<Snowflake, PermissionOverwrites>} [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
*/
/**

View File

@@ -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<TextChannel>}
*/