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

feat(GuildChannel): allow to set all options when cloning (#2937)

Browse Source
This commit is contained in:
SpaceEEC
2018-11-17 15:43:04 +01:00
committed by GitHub
parent 81ff5075e4
commit d92ee2ff99
2 changed files with 14 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/structures/GuildChannel.js
View File

@@ -447,35 +447,37 @@ class GuildChannel extends Channel {
return invites;
}
/* eslint-disable max-len */
/**
* Clones this channel.
* @param {Object} [options] The options
* @param {string} [options.name=this.name] Optional name for the new channel, otherwise it has the name
* of this channel
* @param {boolean} [options.withPermissions=true] Whether to clone the channel with this channel's
* permission overwrites
* @param {boolean} [options.withTopic=true] Whether to clone the channel with this channel's topic
* @param {string} [options.name=this.name] Name of the new channel
* @param {OverwriteResolvable[]|Collection<Snowflake, OverwriteResolvable>} [options.permissionOverwrites=this.permissionOverwrites]
* Permission overwrites of the new channel
* @param {string} [options.type=this.type] Type of the new channel
* @param {string} [options.topic=this.topic] Topic of the new channel (only text)
* @param {boolean} [options.nsfw=this.nsfw] Whether the new channel is nsfw (only text)
* @param {number} [options.bitrate=this.bitrate] Bitrate of the new channel in bits (only voice)
* @param {number} [options.userLimit=this.userLimit] Maximum amount of users allowed in the new channel (only voice)
* @param {ChannelResolvable} [options.parent=this.parent] The parent of the new channel
* @param {number} [options.rateLimitPerUser=ThisType.rateLimitPerUser] Ratelimit per user for the new channel (only text)
* @param {ChannelResolvable} [options.parent=this.parent] Parent of the new channel
* @param {string} [options.reason] Reason for cloning this channel
* @returns {Promise<GuildChannel>}
*/
/* eslint-enable max-len */
clone(options = {}) {
if (typeof options.withPermissions === 'undefined') options.withPermissions = true;
if (typeof options.withTopic === 'undefined') options.withTopic = true;
Util.mergeDefault({
name: this.name,
permissionOverwrites: options.withPermissions ? this.permissionOverwrites : [],
topic: options.withTopic ? this.topic : undefined,
permissionOverwrites: this.permissionOverwrites,
topic: this.topic,
type: this.type,
nsfw: this.nsfw,
parent: this.parent,
bitrate: this.bitrate,
userLimit: this.userLimit,
rateLimitPerUser: this.rateLimitPerUser,
reason: null,
}, options);
options.type = this.type;
return this.guild.channels.create(options.name, options);
}

13
typings/index.d.ts vendored
View File

@@ -523,7 +523,7 @@ declare module 'discord.js' {
public readonly permissionsLocked: boolean;
public readonly position: number;
public rawPosition: number;
public clone(options?: GuildChannelCloneOptions): Promise<GuildChannel>;
public clone(options?: GuildCreateChannelOptions): Promise<GuildChannel>;
public createInvite(options?: InviteOptions): Promise<Invite>;
public createOverwrite(userOrRole: RoleResolvable | UserResolvable, options: PermissionOverwriteOption, reason?: string): Promise<GuildChannel>;
public edit(data: ChannelData, reason?: string): Promise<GuildChannel>;
@@ -1772,17 +1772,6 @@ declare module 'discord.js' {
MESSAGE?: string;
};
type GuildChannelCloneOptions = {
bitrate?: number;
name?: string;
nsfw?: boolean;
parent?: ChannelResolvable;
reason?: string;
userLimit?: number;
withPermissions?: boolean;
withTopic?: boolean;
};
type GuildChannelResolvable = Snowflake | GuildChannel;
type GuildCreateChannelOptions = {