Backport documentation fixes (#3683)

* Presence does not extend Base, therefore presence.client was undocumented

* Document Client#fetchVoiceRegions returning a promise
This commit is contained in:
Ryan Munro
2020-01-14 01:00:13 +11:00
committed by Amish Shah
parent 5556b05241
commit f6d1db6a24
2 changed files with 7 additions and 1 deletions

View File

@@ -349,7 +349,7 @@ class Client extends EventEmitter {
/**
* Obtains the available voice regions from Discord.
* @returns {Collection<string, VoiceRegion>}
* @returns {Promise<Collection<string, VoiceRegion>>}
* @example
* client.fetchVoiceRegions()
* .then(regions => console.log(`Available regions are: ${regions.map(region => region.name).join(', ')}`))

View File

@@ -22,6 +22,12 @@ const { ActivityFlags, Endpoints } = require('../util/Constants');
*/
class Presence {
constructor(data = {}, client) {
/**
* The client that instantiated this
* @name Presence#client
* @type {Client}
* @readonly
*/
Object.defineProperty(this, 'client', { value: client });
/**