Doc fixes, mostly pertaining to Snowflakes (#1218)

GUS!!!! @GusCaplan
This commit is contained in:
Programmix
2017-02-24 12:33:51 -08:00
committed by Schuyler Cebulskie
parent 76637ed10d
commit a029999b09
12 changed files with 27 additions and 27 deletions

View File

@@ -210,7 +210,7 @@ class Client extends EventEmitter {
/**
* All active voice connections that have been established, mapped by channel ID
* @type {Collection<string, VoiceConnection>}
* @type {Collection<Snowflake, VoiceConnection>}
* @readonly
*/
get voiceConnections() {
@@ -303,7 +303,7 @@ class Client extends EventEmitter {
/**
* Obtains a user from Discord, or the user cache if it's already available.
* <warn>This is only available when using a bot account.</warn>
* @param {string} id ID of the user
* @param {Snowflake} id ID of the user
* @param {boolean} [cache=true] Whether to cache the new user object if it isn't already
* @returns {Promise<User>}
*/
@@ -324,7 +324,7 @@ class Client extends EventEmitter {
/**
* Obtains a webhook from Discord.
* @param {string} id ID of the webhook
* @param {Snowflake} id ID of the webhook
* @param {string} [token] Token for the webhook
* @returns {Promise<Webhook>}
*/
@@ -467,7 +467,7 @@ class Client extends EventEmitter {
/**
* Adds/updates a friend's presence in {@link Client#presences}.
* @param {string} id ID of the user
* @param {Snowflake} id ID of the user
* @param {Object} presence Raw presence object from Discord
* @private
*/

View File

@@ -102,7 +102,7 @@ class ClientDataResolver {
}
/**
* Data that can be resolved to give a Channel. This can be:
* Data that can be resolved to give a Channel object. This can be:
* * A Channel object
* * A Message object (the channel the message was sent in)
* * A Guild object (the #general channel)
@@ -124,7 +124,7 @@ class ClientDataResolver {
}
/**
* Resolves a ChannelResolvable to a Channel object
* Resolves a ChannelResolvable to a channel ID
* @param {ChannelResolvable} channel The channel resolvable to resolve
* @returns {?Snowflake}
*/

View File

@@ -10,7 +10,7 @@ const Util = require('../util/Util');
*/
class WebhookClient extends Webhook {
/**
* @param {string} id ID of the webhook
* @param {Snowflake} id ID of the webhook
* @param {string} token Token of the webhook
* @param {ClientOptions} [options] Options for the client
* @example