mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-11 00:53:31 +01:00
Added and fixed a bunch of docs stuff (#1767)
- Fixed a common copy paste fail `the the <thing>` in various places - Apparently I can't type Resolvable correctly, Fixed that wherever applicable - Documented GroupDMChannel#nicks so that it will be displayed on the docs - GroupDMChannel#icon is nullable - Removed empty InviteOptions typdef, as its properties are now documented in GuildChannel#createInvite - MessageMentions#channels is no longer nullable - RoleData#permissions takes a PermissionResolvable or an array of them - Webhook#avatar is nullable - Added HTTPOptions typedef and added it to ClientOptions typedef - ClientUserChannelOverride#muted is for a channel and not a guild directly
This commit is contained in:
@@ -346,7 +346,7 @@ class ClientUser extends User {
|
||||
* @property {string} [accessToken] Access token to use to add a user to the Group DM
|
||||
* (only available if a bot is creating the DM)
|
||||
* @property {string} [nick] Permanent nickname (only available if a bot is creating the DM)
|
||||
* @property {string} [id] If no user resolveable is provided and you want to assign nicknames
|
||||
* @property {string} [id] If no user resolvable is provided and you want to assign nicknames
|
||||
* you must provide user ids instead
|
||||
*/
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ const ClientUserChannelOverride = require('./ClientUserChannelOverride');
|
||||
class ClientUserGuildSettings {
|
||||
constructor(data, client) {
|
||||
/**
|
||||
* The client that created the instance of the the user
|
||||
* The client that created the instance of the ClientUserGuildSettings
|
||||
* @name ClientUserGuildSettings#client
|
||||
* @type {Client}
|
||||
* @readonly
|
||||
|
||||
@@ -49,7 +49,7 @@ class GroupDMChannel extends Channel {
|
||||
|
||||
/**
|
||||
* A hash of this Group DM icon
|
||||
* @type {string}
|
||||
* @type {?string}
|
||||
*/
|
||||
this.icon = data.icon;
|
||||
|
||||
@@ -71,11 +71,13 @@ class GroupDMChannel extends Channel {
|
||||
*/
|
||||
this.applicationID = data.application_id;
|
||||
|
||||
/**
|
||||
* Nicknames for group members
|
||||
* @type {?Collection<Snowflake, string>}
|
||||
*/
|
||||
if (data.nicks) this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick]));
|
||||
if (data.nicks) {
|
||||
/**
|
||||
* Nicknames for group members
|
||||
* @type {?Collection<Snowflake, string>}
|
||||
*/
|
||||
this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick]));
|
||||
}
|
||||
|
||||
if (!this.recipients) {
|
||||
/**
|
||||
@@ -181,7 +183,7 @@ class GroupDMChannel extends Channel {
|
||||
/**
|
||||
* Adds an user to this Group DM.
|
||||
* @param {Object} options Options for this method
|
||||
* @param {UserResolveable} options.user User to add to this Group DM
|
||||
* @param {UserResolvable} options.user User to add to this Group DM
|
||||
* @param {string} [options.accessToken] Access token to use to add the user to this Group DM
|
||||
* (only available under a bot account)
|
||||
* @param {string} [options.nick] Permanent nickname to give the user (only available under a bot account)
|
||||
@@ -198,7 +200,7 @@ class GroupDMChannel extends Channel {
|
||||
|
||||
/**
|
||||
* Removes an user from this Group DM.
|
||||
* @param {UserResolveable} user User to remove
|
||||
* @param {UserResolvable} user User to remove
|
||||
* @returns {Promise<GroupDMChannel>}
|
||||
*/
|
||||
removeUser(user) {
|
||||
|
||||
@@ -25,7 +25,7 @@ const { Error, TypeError } = require('../errors');
|
||||
class Guild {
|
||||
constructor(client, data) {
|
||||
/**
|
||||
* The client that created the instance of the the guild
|
||||
* The client that created the instance of the guild
|
||||
* @name Guild#client
|
||||
* @type {Client}
|
||||
* @readonly
|
||||
@@ -912,9 +912,9 @@ class Guild {
|
||||
/**
|
||||
* Can be used to overwrite permissions when creating a channel.
|
||||
* @typedef {Object} ChannelCreationOverwrites
|
||||
* @property {PermissionResolveable[]|number} [allow] The permissions to allow
|
||||
* @property {PermissionResolveable[]|number} [deny] The permissions to deny
|
||||
* @property {RoleResolveable|UserResolvable} id ID of the group or member this overwrite is for
|
||||
* @property {PermissionResolvable[]|number} [allow] The permissions to allow
|
||||
* @property {PermissionResolvable[]|number} [deny] The permissions to deny
|
||||
* @property {RoleResolvable|UserResolvable} id ID of the group or member this overwrite is for
|
||||
*/
|
||||
|
||||
/**
|
||||
|
||||
@@ -274,15 +274,9 @@ class GuildChannel extends Channel {
|
||||
return this.edit({ topic }, reason);
|
||||
}
|
||||
|
||||
/**
|
||||
* Options given when creating a guild channel invite.
|
||||
* @typedef {Object} InviteOptions
|
||||
|
||||
*/
|
||||
|
||||
/**
|
||||
* Create an invite to this guild channel.
|
||||
* @param {InviteOptions} [options={}] Options for the invite
|
||||
* @param {Object} [options={}] Options for the invite
|
||||
* @param {boolean} [options.temporary=false] Whether members that joined via the invite should be automatically
|
||||
* kicked after 24 hours if they have not yet received a role
|
||||
* @param {number} [options.maxAge=86400] How long the invite should last (in seconds, 0 for forever)
|
||||
|
||||
@@ -103,7 +103,7 @@ class MessageMentions {
|
||||
|
||||
/**
|
||||
* Any channels that were mentioned
|
||||
* @type {?Collection<Snowflake, GuildChannel>}
|
||||
* @type {Collection<Snowflake, GuildChannel>}
|
||||
* @readonly
|
||||
*/
|
||||
get channels() {
|
||||
|
||||
@@ -186,7 +186,7 @@ class Role {
|
||||
* @property {ColorResolvable} [color] The color of the role, either a hex string or a base 10 number
|
||||
* @property {boolean} [hoist] Whether or not the role should be hoisted
|
||||
* @property {number} [position] The position of the role
|
||||
* @property {string[]} [permissions] The permissions of the role
|
||||
* @property {PermissionResolvable|PermissionResolvable[]} [permissions] The permissions of the role
|
||||
* @property {boolean} [mentionable] Whether or not the role should be mentionable
|
||||
*/
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ const { Error } = require('../errors');
|
||||
class User {
|
||||
constructor(client, data) {
|
||||
/**
|
||||
* The client that created the instance of the the user
|
||||
* The client that created the instance of the user
|
||||
* @name User#client
|
||||
* @type {Client}
|
||||
* @readonly
|
||||
|
||||
@@ -14,7 +14,7 @@ class UserProfile {
|
||||
this.user = user;
|
||||
|
||||
/**
|
||||
* The client that created the instance of the the UserProfile.
|
||||
* The client that created the instance of the UserProfile.
|
||||
* @name UserProfile#client
|
||||
* @type {Client}
|
||||
* @readonly
|
||||
|
||||
@@ -40,7 +40,7 @@ class Webhook {
|
||||
|
||||
/**
|
||||
* The avatar for the webhook
|
||||
* @type {string}
|
||||
* @type {?string}
|
||||
*/
|
||||
this.avatar = data.avatar;
|
||||
|
||||
|
||||
@@ -186,7 +186,7 @@ class Collector extends EventEmitter {
|
||||
collect() {}
|
||||
|
||||
/**
|
||||
* Handles incoming events from the the `handleDispose`. Returns null if the event should not
|
||||
* Handles incoming events from the `handleDispose`. Returns null if the event should not
|
||||
* be disposed, or returns the key that should be removed.
|
||||
* @see Collector#handleDispose
|
||||
* @param {...*} args Any args the event listener emits
|
||||
|
||||
Reference in New Issue
Block a user