mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 08:33:30 +01:00
Various documentation adjustments (#2001)
* docs(various): Add "at" to createdAt description * docs(Client): Adjust to fit with guilds property * docs(various): Adjust phrasing & fix typos * docs(various): Clarifications * docs(Permissions): fix numerus * docs(DataStore): capitalize DataStore * docs(various): Formatting changes * docs(Presence): Expand RichPresenceAssets docs * Add space
This commit is contained in:
@@ -232,7 +232,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* The time the guild was created
|
||||
* The time the guild was created at
|
||||
* @type {Date}
|
||||
* @readonly
|
||||
*/
|
||||
@@ -423,7 +423,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch a collection of banned users in this guild.
|
||||
* Fetches a collection of banned users in this guild.
|
||||
* The returned collection contains user objects keyed under `user` and reasons keyed under `reason`.
|
||||
* @returns {Promise<Collection<Snowflake, Object>>}
|
||||
*/
|
||||
@@ -440,7 +440,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch a collection of invites to this guild.
|
||||
* Fetches a collection of invites to this guild.
|
||||
* Resolves with a collection mapping invites by their codes.
|
||||
* @returns {Promise<Collection<string, Invite>>}
|
||||
*/
|
||||
@@ -457,7 +457,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch all webhooks for the guild.
|
||||
* Fetches all webhooks for the guild.
|
||||
* @returns {Promise<Collection<Snowflake, Webhook>>}
|
||||
*/
|
||||
fetchWebhooks() {
|
||||
@@ -469,7 +469,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch available voice regions.
|
||||
* Fetches available voice regions.
|
||||
* @returns {Promise<Collection<string, VoiceRegion>>}
|
||||
*/
|
||||
fetchVoiceRegions() {
|
||||
@@ -481,7 +481,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch audit logs for this guild.
|
||||
* Fetches audit logs for this guild.
|
||||
* @param {Object} [options={}] Options for fetching audit logs
|
||||
* @param {Snowflake|GuildAuditLogsEntry} [options.before] Limit to entries from before specified entry
|
||||
* @param {Snowflake|GuildAuditLogsEntry} [options.after] Limit to entries from after specified entry
|
||||
@@ -606,7 +606,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the level of the explicit content filter.
|
||||
* Edits the level of the explicit content filter.
|
||||
* @param {number} explicitContentFilter The new level of the explicit content filter
|
||||
* @param {string} [reason] Reason for changing the level of the guild's explicit content filter
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -616,7 +616,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the name of the guild.
|
||||
* Edits the name of the guild.
|
||||
* @param {string} name The new name of the guild
|
||||
* @param {string} [reason] Reason for changing the guild's name
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -631,7 +631,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the region of the guild.
|
||||
* Edits the region of the guild.
|
||||
* @param {string} region The new region of the guild
|
||||
* @param {string} [reason] Reason for changing the guild's region
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -646,7 +646,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the verification level of the guild.
|
||||
* Edits the verification level of the guild.
|
||||
* @param {number} verificationLevel The new verification level of the guild
|
||||
* @param {string} [reason] Reason for changing the guild's verification level
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -661,7 +661,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the AFK channel of the guild.
|
||||
* Edits the AFK channel of the guild.
|
||||
* @param {ChannelResolvable} afkChannel The new AFK channel
|
||||
* @param {string} [reason] Reason for changing the guild's AFK channel
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -676,7 +676,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the system channel of the guild.
|
||||
* Edits the system channel of the guild.
|
||||
* @param {ChannelResolvable} systemChannel The new system channel
|
||||
* @param {string} [reason] Reason for changing the guild's system channel
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -691,7 +691,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit the AFK timeout of the guild.
|
||||
* Edits the AFK timeout of the guild.
|
||||
* @param {number} afkTimeout The time in seconds that a user must be idle to be considered AFK
|
||||
* @param {string} [reason] Reason for changing the guild's AFK timeout
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -706,7 +706,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a new guild icon.
|
||||
* Sets a new guild icon.
|
||||
* @param {Base64Resolvable|BufferResolvable} icon The new icon of the guild
|
||||
* @param {string} [reason] Reason for changing the guild's icon
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -736,7 +736,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a new guild splash screen.
|
||||
* Sets a new guild splash screen.
|
||||
* @param {Base64Resolvable|BufferResolvable} splash The new splash screen of the guild
|
||||
* @param {string} [reason] Reason for changing the guild's splash screen
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -779,7 +779,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Allow direct messages from guild members.
|
||||
* Whether to allow direct messages from guild members.
|
||||
* <warn>This is only available when using a user account.</warn>
|
||||
* @param {boolean} allow Whether to allow direct messages
|
||||
* @returns {Promise<Guild>}
|
||||
@@ -1050,7 +1050,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Causes the client to leave the guild.
|
||||
* Leaves the guild.
|
||||
* @returns {Promise<Guild>}
|
||||
* @example
|
||||
* // Leave a guild
|
||||
@@ -1065,7 +1065,7 @@ class Guild extends Base {
|
||||
}
|
||||
|
||||
/**
|
||||
* Causes the client to delete the guild.
|
||||
* Deletes the guild.
|
||||
* @returns {Promise<Guild>}
|
||||
* @example
|
||||
* // Delete a guild
|
||||
|
||||
Reference in New Issue
Block a user