dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-06-06 08:11:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(TextChanne): specify unit of rateLimitPerUser (#3272)

Browse source 
* 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 16fcfa3db3
commit 55447fd4da
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/structures/GuildChannel.js
View file

@ -291,7 +291,7 @@ class GuildChannel extends Channel {
* Lock the permissions of the channel to what the parent's permissions are * Lock the permissions of the channel to what the parent's permissions are
* @property {OverwriteResolvable[]|Collection<Snowflake, OverwriteResolvable>} [permissionOverwrites] * @property {OverwriteResolvable[]|Collection<Snowflake, OverwriteResolvable>} [permissionOverwrites]
* Permission overwrites for the channel * Permission overwrites for the channel
* @property {number} [rateLimitPerUser] The ratelimit per user for the channel * @property {number} [rateLimitPerUser] The ratelimit per user for the channel in seconds
*/ */
/** /**

4
src/structures/TextChannel.js
View file

@ -50,7 +50,7 @@ class TextChannel extends GuildChannel {
this.lastMessageID = data.last_message_id; this.lastMessageID = data.last_message_id;
/** /**
* The ratelimit per user for this channel * The ratelimit per user for this channel in seconds
* @type {number} * @type {number}
*/ */
this.rateLimitPerUser = data.rate_limit_per_user || 0; this.rateLimitPerUser = data.rate_limit_per_user || 0;
@ -66,7 +66,7 @@ class TextChannel extends GuildChannel {
/** /**
* Sets the rate limit per user for this channel. * 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 * @param {string} [reason] Reason for changing the channel's ratelimits
* @returns {Promise<TextChannel>} * @returns {Promise<TextChannel>}
*/ */