diff --git a/src/managers/StageInstanceManager.js b/src/managers/StageInstanceManager.js index d3684a9a6..7ad758d3b 100644 --- a/src/managers/StageInstanceManager.js +++ b/src/managers/StageInstanceManager.js @@ -33,9 +33,16 @@ class StageInstanceManager extends CachedManager { * @property {PrivacyLevel|number} [privacyLevel] The privacy level of the stage instance */ + /** + * Data that can be resolved to a Stage Channel object. This can be: + * * A StageChannel + * * A Snowflake + * @typedef {StageChannel|Snowflake} StageChannelResolvable + */ + /** * Creates a new stage instance. - * @param {StageChannel|Snowflake} channel The stage channel to associate the created stage instance to + * @param {StageChannelResolvable} channel The stage channel to associate the created stage instance to * @param {StageInstanceCreateOptions} options The options to create the stage instance * @returns {Promise} * @example @@ -68,7 +75,7 @@ class StageInstanceManager extends CachedManager { /** * Fetches the stage instance associated with a stage channel, if it exists. - * @param {StageChannel|Snowflake} channel The stage channel whose associated stage instance is to be fetched + * @param {StageChannelResolvable} channel The stage channel whose associated stage instance is to be fetched * @param {BaseFetchOptions} [options] Additional options for this fetch * @returns {Promise} * @example @@ -99,7 +106,7 @@ class StageInstanceManager extends CachedManager { /** * Edits an existing stage instance. - * @param {StageChannel|Snowflake} channel The stage channel whose associated stage instance is to be edited + * @param {StageChannelResolvable} channel The stage channel whose associated stage instance is to be edited * @param {StageInstanceEditOptions} options The options to edit the stage instance * @returns {Promise} * @example @@ -135,7 +142,7 @@ class StageInstanceManager extends CachedManager { /** * Deletes an existing stage instance. - * @param {StageChannel|Snowflake} channel The stage channel whose associated stage instance is to be deleted + * @param {StageChannelResolvable} channel The stage channel whose associated stage instance is to be deleted * @returns {Promise} */ async delete(channel) { diff --git a/typings/index.d.ts b/typings/index.d.ts index 2921a3872..18cac0e61 100644 --- a/typings/index.d.ts +++ b/typings/index.d.ts @@ -2715,10 +2715,10 @@ export class RoleManager extends CachedManager export class StageInstanceManager extends CachedManager { public constructor(guild: Guild, iterable?: Iterable); public guild: Guild; - public create(channel: StageChannel | Snowflake, options: StageInstanceCreateOptions): Promise; - public fetch(channel: StageChannel | Snowflake, options?: BaseFetchOptions): Promise; - public edit(channel: StageChannel | Snowflake, options: StageInstanceEditOptions): Promise; - public delete(channel: StageChannel | Snowflake): Promise; + public create(channel: StageChannelResolvable, options: StageInstanceCreateOptions): Promise; + public fetch(channel: StageChannelResolvable, options?: BaseFetchOptions): Promise; + public edit(channel: StageChannelResolvable, options: StageInstanceEditOptions): Promise; + public delete(channel: StageChannelResolvable): Promise; } export class ThreadManager extends CachedManager { @@ -4644,6 +4644,8 @@ export type SystemChannelFlagsResolvable = BitFieldResolvable; +export type StageChannelResolvable = StageChannel | Snowflake; + export interface StageInstanceEditOptions { topic?: string; privacyLevel?: PrivacyLevel | number;