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

types: Implement GuildChannelEditOptions (#8184)

Browse Source
This commit is contained in:
Jiralite
2022-06-29 23:37:38 +01:00
committed by GitHub
parent 8421f9203b
commit b83e0c0caf
3 changed files with 24 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/discord.js/src/managers/GuildChannelManager.js
View File

@@ -199,8 +199,8 @@ class GuildChannelManager extends CachedManager {
} }
/** /**
* The data for a guild channel. * Options used to edit a guild channel.
* @typedef {Object} ChannelData * @typedef {Object} GuildChannelEditOptions
* @property {string} [name] The name of the channel * @property {string} [name] The name of the channel
* @property {ChannelType} [type] The type of the channel (only conversion between text and news is supported) * @property {ChannelType} [type] The type of the channel (only conversion between text and news is supported)
* @property {number} [position] The position of the channel * @property {number} [position] The position of the channel
@@ -224,7 +224,7 @@ class GuildChannelManager extends CachedManager {
/** /**
* Edits the channel. * Edits the channel.
* @param {GuildChannelResolvable} channel The channel to edit * @param {GuildChannelResolvable} channel The channel to edit
* @param {ChannelData} data The new data for the channel * @param {GuildChannelEditOptions} data Options for editing the channel
* @returns {Promise<GuildChannel>} * @returns {Promise<GuildChannel>}
* @example * @example
* // Edit a channel * // Edit a channel

2
packages/discord.js/src/structures/GuildChannel.js
View File

@@ -264,7 +264,7 @@ class GuildChannel extends BaseChannel {
/** /**
* Edits the channel. * Edits the channel.
* @param {ChannelEditData} data The new data for the channel * @param {GuildChannelEditOptions} data The new data for the channel
* @returns {Promise<GuildChannel>} * @returns {Promise<GuildChannel>}
* @example * @example
* // Edit a channel * // Edit a channel

43
packages/discord.js/typings/index.d.ts vendored
View File

@@ -1248,7 +1248,7 @@ export abstract class GuildChannel extends BaseChannel {
public get viewable(): boolean; public get viewable(): boolean;
public clone(options?: GuildChannelCloneOptions): Promise<this>; public clone(options?: GuildChannelCloneOptions): Promise<this>;
public delete(reason?: string): Promise<this>; public delete(reason?: string): Promise<this>;
public edit(data: ChannelEditData): Promise<this>; public edit(data: GuildChannelEditOptions): Promise<this>;
public equals(channel: GuildChannel): boolean; public equals(channel: GuildChannel): boolean;
public lockPermissions(): Promise<this>; public lockPermissions(): Promise<this>;
public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>; public permissionsFor(memberOrRole: GuildMember | Role, checkAdmin?: boolean): Readonly<PermissionsBitField>;
@@ -3330,7 +3330,7 @@ export class GuildChannelManager extends CachedManager<Snowflake, GuildBasedChan
): Promise<MappedGuildChannelTypes[T]>; ): Promise<MappedGuildChannelTypes[T]>;
public create(options: GuildChannelCreateOptions): Promise<TextChannel>; public create(options: GuildChannelCreateOptions): Promise<TextChannel>;
public createWebhook(options: WebhookCreateOptions): Promise<Webhook>; public createWebhook(options: WebhookCreateOptions): Promise<Webhook>;
public edit(channel: GuildChannelResolvable, data: ChannelEditData): Promise<GuildChannel>; public edit(channel: GuildChannelResolvable, data: GuildChannelEditOptions): Promise<GuildChannel>;
public fetch(id: Snowflake, options?: BaseFetchOptions): Promise<NonThreadGuildBasedChannel | null>; public fetch(id: Snowflake, options?: BaseFetchOptions): Promise<NonThreadGuildBasedChannel | null>;
public fetch(id?: undefined, options?: BaseFetchOptions): Promise<Collection<Snowflake, NonThreadGuildBasedChannel>>; public fetch(id?: undefined, options?: BaseFetchOptions): Promise<Collection<Snowflake, NonThreadGuildBasedChannel>>;
public fetchWebhooks(channel: GuildChannelResolvable): Promise<Collection<Snowflake, Webhook>>; public fetchWebhooks(channel: GuildChannelResolvable): Promise<Collection<Snowflake, Webhook>>;
@@ -4011,27 +4011,6 @@ export interface ChannelCreationOverwrites {
id: RoleResolvable | UserResolvable; id: RoleResolvable | UserResolvable;
} }
export interface ChannelData {
name?: string;
type?: ChannelType.GuildText | ChannelType.GuildNews;
position?: number;
topic?: string | null;
nsfw?: boolean;
bitrate?: number;
userLimit?: number;
parent?: CategoryChannelResolvable | null;
rateLimitPerUser?: number;
lockPermissions?: boolean;
permissionOverwrites?: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
defaultAutoArchiveDuration?: ThreadAutoArchiveDuration;
rtcRegion?: string | null;
videoQualityMode?: VideoQualityMode | null;
}
export interface ChannelEditData extends ChannelData {
reason?: string;
}
export type ChannelMention = `<#${Snowflake}>`; export type ChannelMention = `<#${Snowflake}>`;
export interface ChannelPosition { export interface ChannelPosition {
@@ -4681,6 +4660,24 @@ export interface GuildChannelCloneOptions extends Omit<GuildChannelCreateOptions
name?: string; name?: string;
} }
export interface GuildChannelEditOptions {
name?: string;
type?: ChannelType.GuildText | ChannelType.GuildNews;
position?: number;
topic?: string | null;
nsfw?: boolean;
bitrate?: number;
userLimit?: number;
parent?: CategoryChannelResolvable | null;
rateLimitPerUser?: number;
lockPermissions?: boolean;
permissionOverwrites?: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
defaultAutoArchiveDuration?: ThreadAutoArchiveDuration;
rtcRegion?: string | null;
videoQualityMode?: VideoQualityMode | null;
reason?: string;
}
export interface GuildChannelOverwriteOptions { export interface GuildChannelOverwriteOptions {
reason?: string; reason?: string;
type?: number; type?: number;