From 6f0f42b327798510526edabd610cba6e6e39f64b Mon Sep 17 00:00:00 2001 From: almeidx Date: Sat, 27 Sep 2025 14:44:20 +0100 Subject: [PATCH] docs: use LocalizationMap where applicable --- .../src/structures/ApplicationCommand.js | 24 +++++++++---------- .../ApplicationRoleConnectionMetadata.js | 4 ++-- .../src/structures/ClientApplication.js | 4 ++-- packages/discord.js/src/util/APITypes.js | 5 ++++ 4 files changed, 21 insertions(+), 16 deletions(-) diff --git a/packages/discord.js/src/structures/ApplicationCommand.js b/packages/discord.js/src/structures/ApplicationCommand.js index ad9382be5565..e78e4ecad12c 100644 --- a/packages/discord.js/src/structures/ApplicationCommand.js +++ b/packages/discord.js/src/structures/ApplicationCommand.js @@ -83,7 +83,7 @@ class ApplicationCommand extends Base { /** * The name localizations for this command * - * @type {?Object} + * @type {?LocalizationMap} */ this.nameLocalizations = data.name_localizations; } else { @@ -114,7 +114,7 @@ class ApplicationCommand extends Base { /** * The description localizations for this command * - * @type {?Object} + * @type {?LocalizationMap} */ this.descriptionLocalizations = data.description_localizations; } else { @@ -239,11 +239,11 @@ class ApplicationCommand extends Base { * @typedef {Object} ApplicationCommandData * @property {string} name The name of the command, must be in all lowercase if type is * {@link ApplicationCommandType.ChatInput} - * @property {Object} [nameLocalizations] The localizations for the command name + * @property {LocalizationMap} [nameLocalizations] The localizations for the command name * @property {string} description The description of the command, * if type is {@link ApplicationCommandType.ChatInput} or {@link ApplicationCommandType.PrimaryEntryPoint} * @property {boolean} [nsfw] Whether the command is age-restricted - * @property {Object} [descriptionLocalizations] The localizations for the command description, + * @property {LocalizationMap} [descriptionLocalizations] The localizations for the command description, * if type is {@link ApplicationCommandType.ChatInput} or {@link ApplicationCommandType.PrimaryEntryPoint} * @property {ApplicationCommandType} [type=ApplicationCommandType.ChatInput] The type of the command * @property {ApplicationCommandOptionData[]} [options] Options for the command @@ -265,9 +265,9 @@ class ApplicationCommand extends Base { * @typedef {Object} ApplicationCommandOptionData * @property {ApplicationCommandOptionType} type The type of the option * @property {string} name The name of the option - * @property {Object} [nameLocalizations] The name localizations for the option + * @property {LocalizationMap} [nameLocalizations] The name localizations for the option * @property {string} description The description of the option - * @property {Object} [descriptionLocalizations] The description localizations for the option + * @property {LocalizationMap} [descriptionLocalizations] The description localizations for the option * @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a * {@link ApplicationCommandOptionType.String}, {@link ApplicationCommandOptionType.Integer} or * {@link ApplicationCommandOptionType.Number} option @@ -289,7 +289,7 @@ class ApplicationCommand extends Base { /** * @typedef {Object} ApplicationCommandOptionChoiceData * @property {string} name The name of the choice - * @property {Object} [nameLocalizations] The localized names for this choice + * @property {LocalizationMap} [nameLocalizations] The localized names for this choice * @property {string|number} value The value of the choice */ @@ -323,7 +323,7 @@ class ApplicationCommand extends Base { /** * Edits the localized names of this ApplicationCommand * - * @param {Object} nameLocalizations The new localized names for the command + * @param {LocalizationMap} nameLocalizations The new localized names for the command * @returns {Promise} * @example * // Edit the name localizations of this command @@ -351,7 +351,7 @@ class ApplicationCommand extends Base { /** * Edits the localized descriptions of this ApplicationCommand * - * @param {Object} descriptionLocalizations The new localized descriptions for the command + * @param {LocalizationMap} descriptionLocalizations The new localized descriptions for the command * @returns {Promise} * @example * // Edit the description localizations of this command @@ -568,10 +568,10 @@ class ApplicationCommand extends Base { * @typedef {Object} ApplicationCommandOption * @property {ApplicationCommandOptionType} type The type of the option * @property {string} name The name of the option - * @property {Object} [nameLocalizations] The localizations for the option name + * @property {LocalizationMap} [nameLocalizations] The localizations for the option name * @property {string} [nameLocalized] The localized name for this option * @property {string} description The description of the option - * @property {Object} [descriptionLocalizations] The localizations for the option description + * @property {LocalizationMap} [descriptionLocalizations] The localizations for the option description * @property {string} [descriptionLocalized] The localized description for this option * @property {boolean} [required] Whether the option is required * @property {boolean} [autocomplete] Whether the autocomplete interaction is enabled for a @@ -597,7 +597,7 @@ class ApplicationCommand extends Base { * @typedef {Object} ApplicationCommandOptionChoice * @property {string} name The name of the choice * @property {?string} nameLocalized The localized name of the choice in the provided locale, if any - * @property {?Object} [nameLocalizations] The localized names for this choice + * @property {?LocalizationMap} [nameLocalizations] The localized names for this choice * @property {string|number} value The value of the choice */ diff --git a/packages/discord.js/src/structures/ApplicationRoleConnectionMetadata.js b/packages/discord.js/src/structures/ApplicationRoleConnectionMetadata.js index d19624917994..be21d0ae5eba 100644 --- a/packages/discord.js/src/structures/ApplicationRoleConnectionMetadata.js +++ b/packages/discord.js/src/structures/ApplicationRoleConnectionMetadata.js @@ -15,7 +15,7 @@ class ApplicationRoleConnectionMetadata { /** * The name localizations for this metadata field * - * @type {?Object} + * @type {?LocalizationMap} */ this.nameLocalizations = data.name_localizations ?? null; @@ -29,7 +29,7 @@ class ApplicationRoleConnectionMetadata { /** * The description localizations for this metadata field * - * @type {?Object} + * @type {?LocalizationMap} */ this.descriptionLocalizations = data.description_localizations ?? null; diff --git a/packages/discord.js/src/structures/ClientApplication.js b/packages/discord.js/src/structures/ClientApplication.js index 9fd6d08c4df4..701f7e6b9c9b 100644 --- a/packages/discord.js/src/structures/ClientApplication.js +++ b/packages/discord.js/src/structures/ClientApplication.js @@ -407,9 +407,9 @@ class ClientApplication extends Application { * * @typedef {Object} ApplicationRoleConnectionMetadataEditOptions * @property {string} name The name of the metadata field - * @property {?Object} [nameLocalizations] The name localizations for the metadata field + * @property {?LocalizationMap} [nameLocalizations] The name localizations for the metadata field * @property {string} description The description of the metadata field - * @property {?Object} [descriptionLocalizations] The description localizations for the metadata field + * @property {?LocalizationMap} [descriptionLocalizations] The description localizations for the metadata field * @property {string} key The dictionary key of the metadata field * @property {ApplicationRoleConnectionMetadataType} type The type of the metadata field */ diff --git a/packages/discord.js/src/util/APITypes.js b/packages/discord.js/src/util/APITypes.js index 6a0390111ff3..5a75b4a2747d 100644 --- a/packages/discord.js/src/util/APITypes.js +++ b/packages/discord.js/src/util/APITypes.js @@ -539,6 +539,11 @@ * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/Locale} */ +/** + * @external LocalizationMap + * @see {@link https://discord-api-types.dev/api/discord-api-types-v10#LocalizationMap} + */ + /** * @external MessageActivityType * @see {@link https://discord-api-types.dev/api/discord-api-types-v10/enum/MessageActivityType}