Docs: merge PermissionOverwriteOptions and OverwriteData (#2738)

* Docs: merge PermissionOverwriteOptions and OverwriteData

* fix user-member and replace eslint-disable with linebreaks

* consistency fix

* Fix: remove empty line between jsdocs and method

* Fix: allowed/denied to allow/deny to conform with recent master changes
This commit is contained in:
Souji
2018-08-24 16:51:15 +02:00
committed by Crawl
parent c4df02782e
commit cb08a0961a
2 changed files with 11 additions and 18 deletions

View File

@@ -21,14 +21,6 @@ class GuildChannelStore extends DataStore {
return Channel.create(this.client, data, this.guild);
}
/**
* Can be used to overwrite permissions when creating a channel.
* @typedef {Object} PermissionOverwriteOptions
* @property {PermissionResolvable} [allow] The permissions to allow
* @property {PermissionResolvable} [deny] The permissions to deny
* @property {RoleResolvable|UserResolvable} id ID of the role or member this overwrite is for
*/
/**
* Creates a new channel in the guild.
* @param {string} name The name of the new channel
@@ -39,7 +31,8 @@ class GuildChannelStore extends DataStore {
* @param {number} [options.bitrate] Bitrate of the new channel in bits (only voice)
* @param {number} [options.userLimit] Maximum amount of users allowed in the new channel (only voice)
* @param {ChannelResolvable} [options.parent] Parent of the new channel
* @param {Array<PermissionOverwrites|PermissionOverwriteOptions>} [options.overwrites] Permission overwrites
* @param {OverwriteData[]|Collection<Snowflake, PermissionOverwrites>} [options.overwrites]
* Permission overwrites of the new channel
* @param {string} [options.reason] Reason for creating the channel
* @returns {Promise<GuildChannel>}
* @example