dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-07-08 12:40:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

More docs cleanup

Browse source
This commit is contained in:
Crawl 2017-08-20 22:15:51 +02:00
parent c7d1507e19
commit 2478092d44
7 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/client/voice/VoiceConnection.js
View file

@ -165,7 +165,7 @@ class VoiceConnection extends EventEmitter {
} }
/** /**
* Set the token and endpoint required to connect to the the voice servers. * Set the token and endpoint required to connect to the voice servers.
* @param {string} token The voice token * @param {string} token The voice token
* @param {string} endpoint The voice endpoint * @param {string} endpoint The voice endpoint
* @returns {void} * @returns {void}

16
src/structures/GroupDMChannel.js
View file

@ -47,8 +47,8 @@ class GroupDMChannel extends Channel {
this.name = data.name; this.name = data.name;
/** /**
* A hash of the Group DM icon. * A hash of this Group DM icon
* @type {string} * @type {?string}
*/ */
this.icon = data.icon; this.icon = data.icon;
@ -70,11 +70,13 @@ class GroupDMChannel extends Channel {
*/ */
this.applicationID = data.application_id; this.applicationID = data.application_id;
/** if (data.nicks) {
* Nicknames for group members /**
* @type {?Collection<Snowflake, string>} * Nicknames for group members
*/ * @type {?Collection<Snowflake, string>}
if (data.nicks) this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick])); */
this.nicks = new Collection(data.nicks.map(n => [n.id, n.nick]));
}
if (!this.recipients) { if (!this.recipients) {
/** /**

2
src/structures/Guild.js
View file

@ -18,7 +18,7 @@ const Snowflake = require('../util/Snowflake');
class Guild { class Guild {
constructor(client, data) { constructor(client, data) {
/** /**
* The client that created the instance of the the guild * The client that created the instance of the guild
* @name Guild#client * @name Guild#client
* @type {Client} * @type {Client}
* @readonly * @readonly

2
src/structures/MessageMentions.js
View file

@ -102,7 +102,7 @@ class MessageMentions {
/** /**
* Any channels that were mentioned * Any channels that were mentioned
* @type {?Collection<Snowflake, GuildChannel>} * @type {Collection<Snowflake, GuildChannel>}
* @readonly * @readonly
*/ */
get channels() { get channels() {

2
src/structures/User.js
View file

@ -10,7 +10,7 @@ const Snowflake = require('../util/Snowflake');
class User { class User {
constructor(client, data) { constructor(client, data) {
/** /**
* The client that created the instance of the the user * The client that created the instance of the user
* @name User#client * @name User#client
* @type {} * @type {}
* @readonly * @readonly

2
src/structures/Webhook.js
View file

@ -36,7 +36,7 @@ class Webhook {
/** /**
* The avatar for the webhook * The avatar for the webhook
* @type {string} * @type {?string}
*/ */
this.avatar = data.avatar; this.avatar = data.avatar;

4
src/util/Constants.js
View file

@ -555,8 +555,8 @@ exports.UserSettingsMap = {
explicit_content_filter: function explicitContentFilter(type) { // eslint-disable-line func-name-matching explicit_content_filter: function explicitContentFilter(type) { // eslint-disable-line func-name-matching
/** /**
* Safe direct messaging; force people's messages with images to be scanned before they are sent to you * Safe direct messaging; force people's messages with images to be scanned before they are sent to you.
* one of `DISABLED`, `NON_FRIENDS`, `FRIENDS_AND_NON_FRIENDS` * One of `DISABLED`, `NON_FRIENDS`, `FRIENDS_AND_NON_FRIENDS`
* @name ClientUserSettings#explicitContentFilter * @name ClientUserSettings#explicitContentFilter
* @type {string} * @type {string}
*/ */