Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 00:53:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(*Resolvable): make them appear on the docs

Browse Source 
I don't know what part of the docgen is not working properly, but this seems to fix those typedef
to not appear on the documentation
This commit is contained in:
SpaceEEC
2019-06-05 22:18:06 +02:00
parent 8e1857286d
commit 4a2335c69c
3 changed files with 68 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/stores/GuildChannelStore.js
View File

@@ -22,6 +22,31 @@ class GuildChannelStore extends DataStore {
return channel;
}
/**
* Data that can be resolved to give a Guild Channel object. This can be:
* * A GuildChannel object
* * A Snowflake
* @typedef {GuildChannel|Snowflake} GuildChannelResolvable
*/
/**
* Resolves a GuildChannelResolvable to a Channel object.
* @method resolve
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?Channel}
*/
/**
* Resolves a GuildChannelResolvable to a channel ID string.
* @method resolveID
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?Snowflake}
*/
/**
* Creates a new channel in the guild.
* @param {string} name The name of the new channel
@@ -90,31 +115,6 @@ class GuildChannelStore extends DataStore {
});
return this.client.actions.ChannelCreate.handle(data).channel;
}
/**
* Data that can be resolved to give a Guild Channel object. This can be:
* * A GuildChannel object
* * A Snowflake
* @typedef {GuildChannel|Snowflake} GuildChannelResolvable
*/
/**
* Resolves a GuildChannelResolvable to a Channel object.
* @method resolve
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?Channel}
*/
/**
* Resolves a GuildChannelResolvable to a channel ID string.
* @method resolveID
* @memberof GuildChannelStore
* @instance
* @param {GuildChannelResolvable} channel The GuildChannel resolvable to resolve
* @returns {?Snowflake}
*/
}
module.exports = GuildChannelStore;