mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 16:43:31 +01:00
docs: Fixed some missing docstrings or incorrect return types (#2093)
* Fix some missing doc strings
Mainly just readonly tags
* Return an error when guild#allowDMs is ran from a bot account, and fix some return types
* WebhookClient implements Webhook, doesn't extend it
* Fix Client#rateLimit docs not showing what it returns
Cause I wanted to handle this event only to see no return props 🤔
* Actually make Client#rateLimit show the right info
Its an object with all the info
This commit is contained in:
@@ -248,7 +248,7 @@ class ClientUser extends User {
|
||||
/**
|
||||
* Fetches messages that mentioned the client's user.
|
||||
* <warn>This is only available when using a user account.</warn>
|
||||
* @param {Object} [options] Options for the fetch
|
||||
* @param {Object} [options={}] Options for the fetch
|
||||
* @param {number} [options.limit=25] Maximum number of mentions to retrieve
|
||||
* @param {boolean} [options.roles=true] Whether to include role mentions
|
||||
* @param {boolean} [options.everyone=true] Whether to include everyone/here mentions
|
||||
|
||||
@@ -321,7 +321,7 @@ class Guild extends Base {
|
||||
|
||||
/**
|
||||
* System channel for this guild
|
||||
* @type {?GuildChannel}
|
||||
* @type {?TextChannel}
|
||||
* @readonly
|
||||
*/
|
||||
get systemChannel() {
|
||||
@@ -806,6 +806,7 @@ class Guild extends Base {
|
||||
* @returns {Promise<Guild>}
|
||||
*/
|
||||
allowDMs(allow) {
|
||||
if (this.client.user.bot) return Promise.reject(new Error('FEATURE_USER_ONLY'));
|
||||
const settings = this.client.user.settings;
|
||||
if (allow) return settings.removeRestrictedGuild(this);
|
||||
else return settings.addRestrictedGuild(this);
|
||||
@@ -818,7 +819,7 @@ class Guild extends Base {
|
||||
* string, the ban reason. Supplying an object allows you to do both.
|
||||
* @param {number} [options.days=0] Number of days of messages to delete
|
||||
* @param {string} [options.reason] Reason for banning
|
||||
* @returns {Promise<GuildMember|User|string>} Result object will be resolved as specifically as possible.
|
||||
* @returns {Promise<GuildMember|User|Snowflake>} Result object will be resolved as specifically as possible.
|
||||
* If the GuildMember cannot be resolved, the User will instead be attempted to be resolved. If that also cannot
|
||||
* be resolved, the user ID will be the result.
|
||||
* @example
|
||||
|
||||
@@ -77,36 +77,42 @@ class GuildMember extends Base {
|
||||
/**
|
||||
* Whether this member is deafened server-wide
|
||||
* @type {boolean}
|
||||
* @readonly
|
||||
*/
|
||||
get serverDeaf() { return this.voiceState.deaf; }
|
||||
|
||||
/**
|
||||
* Whether this member is muted server-wide
|
||||
* @type {boolean}
|
||||
* @readonly
|
||||
*/
|
||||
get serverMute() { return this.voiceState.mute; }
|
||||
|
||||
/**
|
||||
* Whether this member is self-muted
|
||||
* @type {boolean}
|
||||
* @readonly
|
||||
*/
|
||||
get selfMute() { return this.voiceState.self_mute; }
|
||||
|
||||
/**
|
||||
* Whether this member is self-deafened
|
||||
* @type {boolean}
|
||||
* @readonly
|
||||
*/
|
||||
get selfDeaf() { return this.voiceState.self_deaf; }
|
||||
|
||||
/**
|
||||
* The voice session ID of this member (if any)
|
||||
* @type {?Snowflake}
|
||||
* @readonly
|
||||
*/
|
||||
get voiceSessionID() { return this.voiceState.session_id; }
|
||||
|
||||
/**
|
||||
* The voice channel ID of this member, (if any)
|
||||
* @type {?Snowflake}
|
||||
* @readonly
|
||||
*/
|
||||
get voiceChannelID() { return this.voiceState.channel_id; }
|
||||
|
||||
|
||||
Reference in New Issue
Block a user