mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 16:43:31 +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:
@@ -25,7 +25,7 @@ class Collector extends EventEmitter {
|
||||
super();
|
||||
|
||||
/**
|
||||
* The client
|
||||
* The client that instantiated this Collector
|
||||
* @name Collector#client
|
||||
* @type {Client}
|
||||
* @readonly
|
||||
@@ -115,7 +115,7 @@ class Collector extends EventEmitter {
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a promise that resolves with the next collected element;
|
||||
* Returns a promise that resolves with the next collected element;
|
||||
* rejects with collected elements if the collector finishes without receving a next element
|
||||
* @type {Promise}
|
||||
* @readonly
|
||||
@@ -148,7 +148,7 @@ class Collector extends EventEmitter {
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop this collector and emit the `end` event.
|
||||
* Stops this collector and emits the `end` event.
|
||||
* @param {string} [reason='user'] The reason this collector is ending
|
||||
* @emits Collector#end
|
||||
*/
|
||||
@@ -168,7 +168,7 @@ class Collector extends EventEmitter {
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether the collector should end, and if so, end it.
|
||||
* Checks whether the collector should end, and if so, ends it.
|
||||
*/
|
||||
checkEnd() {
|
||||
const reason = this.endReason();
|
||||
|
||||
@@ -67,12 +67,12 @@ class TextBasedChannel {
|
||||
*/
|
||||
|
||||
/**
|
||||
* Send a message to this channel.
|
||||
* Sends a message to this channel.
|
||||
* @param {StringResolvable} [content] Text for the message
|
||||
* @param {MessageOptions|MessageEmbed|MessageAttachment|MessageAttachment[]} [options={}] Options for the message
|
||||
* @returns {Promise<Message|Message[]>}
|
||||
* @example
|
||||
* // Send a message
|
||||
* // Sends a message
|
||||
* channel.send('hello!')
|
||||
* .then(message => console.log(`Sent message: ${message.content}`))
|
||||
* .catch(console.error);
|
||||
@@ -274,7 +274,7 @@ class TextBasedChannel {
|
||||
}
|
||||
|
||||
/**
|
||||
* Bulk delete given messages that are newer than two weeks.
|
||||
* Bulk deletes given messages that are newer than two weeks.
|
||||
* <warn>This is only available when using a bot account.</warn>
|
||||
* @param {Collection<Snowflake, Message>|Message[]|Snowflake[]|number} messages
|
||||
* Messages or number of messages to delete
|
||||
|
||||
Reference in New Issue
Block a user