mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
docs: inconsistencies
This commit is contained in:
@@ -24,7 +24,7 @@ v12 is still very much a work-in-progress, as we're aiming to make it the best i
|
||||
Only use it if you are fond of living life on the bleeding edge.
|
||||
|
||||
## About
|
||||
discord.js is a powerful [node.js](https://nodejs.org) module that allows you to interact with the
|
||||
discord.js is a powerful [Node.js](https://nodejs.org) module that allows you to interact with the
|
||||
[Discord API](https://discordapp.com/developers/docs/intro) very easily.
|
||||
|
||||
- Object-oriented
|
||||
|
||||
@@ -289,9 +289,8 @@ class Client extends BaseClient {
|
||||
* @returns {Promise<Invite>}
|
||||
* @example
|
||||
* client.fetchInvite('https://discord.gg/bRCvFy9')
|
||||
* .then(invite => {
|
||||
* console.log(`Obtained invite with code: ${invite.code}`);
|
||||
* }).catch(console.error);
|
||||
* .then(invite => console.log(`Obtained invite with code: ${invite.code}`)
|
||||
* .catch(console.error);
|
||||
*/
|
||||
fetchInvite(invite) {
|
||||
const code = DataResolver.resolveInviteCode(invite);
|
||||
@@ -306,9 +305,8 @@ class Client extends BaseClient {
|
||||
* @returns {Promise<Webhook>}
|
||||
* @example
|
||||
* client.fetchWebhook('id', 'token')
|
||||
* .then(webhook => {
|
||||
* console.log(`Obtained webhook with name: ${webhook.name}`);
|
||||
* }).catch(console.error);
|
||||
* .then(webhook => console.log(`Obtained webhook with name: ${webhook.name}`))
|
||||
* .catch(console.error);
|
||||
*/
|
||||
fetchWebhook(id, token) {
|
||||
return this.api.webhooks(id, token).get().then(data => new Webhook(this, data));
|
||||
@@ -319,9 +317,8 @@ class Client extends BaseClient {
|
||||
* @returns {Collection<string, VoiceRegion>}
|
||||
* @example
|
||||
* client.fetchVoiceRegions()
|
||||
* .then(regions => {
|
||||
* console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`);
|
||||
* }).catch(console.error);
|
||||
* .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))
|
||||
* .catch(console.error);
|
||||
*/
|
||||
fetchVoiceRegions() {
|
||||
return this.api.voice.regions.get().then(res => {
|
||||
@@ -380,9 +377,8 @@ class Client extends BaseClient {
|
||||
* @returns {Promise<ClientApplication>}
|
||||
* @example
|
||||
* client.fetchApplication('id')
|
||||
* .then(application => {
|
||||
* console.log(`Obtained application with name: ${application.name}`);
|
||||
* }).catch(console.error);
|
||||
* .then(application => console.log(`Obtained application with name: ${application.name}`)
|
||||
* .catch(console.error);
|
||||
*/
|
||||
fetchApplication(id = '@me') {
|
||||
return this.api.oauth2.applications(id).get()
|
||||
|
||||
@@ -85,12 +85,12 @@ class GuildEmoji extends Emoji {
|
||||
|
||||
/**
|
||||
* Edits the emoji.
|
||||
* @param {Guild} data The new data for the emoji
|
||||
* @param {GuildEmojiEditData} data The new data for the emoji
|
||||
* @param {string} [reason] Reason for editing this emoji
|
||||
* @returns {Promise<GuildEmoji>}
|
||||
* @example
|
||||
* // Edit an emoji
|
||||
* emoji.edit({name: 'newemoji'})
|
||||
* emoji.edit({ name: 'newemoji' })
|
||||
* .then(e => console.log(`Edited emoji ${e}`))
|
||||
* .catch(console.error);
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user