mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-18 04:23:31 +01:00
docs: differ User#send (#9251)
* docs: differate user#send * chore: format * chore: remove some examples * docs: add GuildMember#send example --------- Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
@@ -487,12 +487,22 @@ class GuildMember extends Base {
|
|||||||
json.displayAvatarURL = this.displayAvatarURL();
|
json.displayAvatarURL = this.displayAvatarURL();
|
||||||
return json;
|
return json;
|
||||||
}
|
}
|
||||||
|
|
||||||
// These are here only for documentation purposes - they are implemented by TextBasedChannel
|
|
||||||
/* eslint-disable no-empty-function */
|
|
||||||
send() {}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a message to this user.
|
||||||
|
* @method send
|
||||||
|
* @memberof GuildMember
|
||||||
|
* @instance
|
||||||
|
* @param {string|MessagePayload|MessageCreateOptions} options The options to provide
|
||||||
|
* @returns {Promise<Message>}
|
||||||
|
* @example
|
||||||
|
* // Send a direct message
|
||||||
|
* guildMember.send('Hello!')
|
||||||
|
* .then(message => console.log(`Sent message: ${message.content} to ${guildMember.displayName}`))
|
||||||
|
* .catch(console.error);
|
||||||
|
*/
|
||||||
|
|
||||||
TextBasedChannel.applyToClass(GuildMember);
|
TextBasedChannel.applyToClass(GuildMember);
|
||||||
|
|
||||||
exports.GuildMember = GuildMember;
|
exports.GuildMember = GuildMember;
|
||||||
|
|||||||
@@ -305,12 +305,22 @@ class User extends Base {
|
|||||||
json.bannerURL = this.banner ? this.bannerURL() : this.banner;
|
json.bannerURL = this.banner ? this.bannerURL() : this.banner;
|
||||||
return json;
|
return json;
|
||||||
}
|
}
|
||||||
|
|
||||||
// These are here only for documentation purposes - they are implemented by TextBasedChannel
|
|
||||||
/* eslint-disable no-empty-function */
|
|
||||||
send() {}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sends a message to this user.
|
||||||
|
* @method send
|
||||||
|
* @memberof User
|
||||||
|
* @instance
|
||||||
|
* @param {string|MessagePayload|MessageCreateOptions} options The options to provide
|
||||||
|
* @returns {Promise<Message>}
|
||||||
|
* @example
|
||||||
|
* // Send a direct message
|
||||||
|
* user.send('Hello!')
|
||||||
|
* .then(message => console.log(`Sent message: ${message.content} to ${user.tag}`))
|
||||||
|
* .catch(console.error);
|
||||||
|
*/
|
||||||
|
|
||||||
TextBasedChannel.applyToClass(User);
|
TextBasedChannel.applyToClass(User);
|
||||||
|
|
||||||
module.exports = User;
|
module.exports = User;
|
||||||
|
|||||||
@@ -135,25 +135,6 @@ class TextBasedChannel {
|
|||||||
* })
|
* })
|
||||||
* .then(console.log)
|
* .then(console.log)
|
||||||
* .catch(console.error);
|
* .catch(console.error);
|
||||||
* @example
|
|
||||||
* // Send an embed with a local image inside
|
|
||||||
* channel.send({
|
|
||||||
* content: 'This is an embed',
|
|
||||||
* embeds: [
|
|
||||||
* {
|
|
||||||
* thumbnail: {
|
|
||||||
* url: 'attachment://file.jpg'
|
|
||||||
* }
|
|
||||||
* }
|
|
||||||
* ],
|
|
||||||
* files: [{
|
|
||||||
* attachment: 'entire/path/to/file.jpg',
|
|
||||||
* name: 'file.jpg',
|
|
||||||
* description: 'A description of the file'
|
|
||||||
* }]
|
|
||||||
* })
|
|
||||||
* .then(console.log)
|
|
||||||
* .catch(console.error);
|
|
||||||
*/
|
*/
|
||||||
async send(options) {
|
async send(options) {
|
||||||
const User = require('../User');
|
const User = require('../User');
|
||||||
|
|||||||
Reference in New Issue
Block a user