ci: api-extractor support for docs

2026-03-13 18:13:29 +01:00 · 2022-06-30 15:46:14 +02:00
parent 525bf031a5
commit b2776c22d4
54 changed files with 2608 additions and 343 deletions
--- a/packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts
+++ b/packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts
@@ -53,7 +53,7 @@ export class ContextMenuCommandBuilder {
 	/**
 	 * Sets the name
 	 *
-	 * @param name The name
+	 * @param name - The name
 	 */
 	public setName(name: string) {
 		// Assert the name matches the conditions
@@ -67,7 +67,7 @@ export class ContextMenuCommandBuilder {
 	/**
 	 * Sets the type
 	 *
-	 * @param type The type
+	 * @param type - The type
 	 */
 	public setType(type: ContextMenuCommandType) {
 		// Assert the type is valid
@@ -83,7 +83,7 @@ export class ContextMenuCommandBuilder {
 	 *
 	 * **Note**: If set to `false`, you will have to later `PUT` the permissions for this command.
 	 *
-	 * @param value Whether or not to enable this command by default
+	 * @param value - Whether or not to enable this command by default
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 * @deprecated Use `setDefaultMemberPermissions` or `setDMPermission` instead.
@@ -102,7 +102,7 @@ export class ContextMenuCommandBuilder {
 	 *
 	 * **Note:** You can set this to `'0'` to disable the command by default.
 	 *
-	 * @param permissions The permissions bit field to set
+	 * @param permissions - The permissions bit field to set
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 */
@@ -119,7 +119,7 @@ export class ContextMenuCommandBuilder {
 	 * Sets if the command is available in DMs with the application, only for globally-scoped commands.
 	 * By default, commands are visible.
 	 *
-	 * @param enabled If the command should be enabled in DMs
+	 * @param enabled - If the command should be enabled in DMs
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 */
@@ -135,8 +135,8 @@ export class ContextMenuCommandBuilder {
 	/**
 	 * Sets a name localization
 	 *
-	 * @param locale The locale to set a description for
-	 * @param localizedName The localized description for the given locale
+	 * @param locale - The locale to set a description for
+	 * @param localizedName - The localized description for the given locale
 	 */
 	public setNameLocalization(locale: LocaleString, localizedName: string | null) {
 		if (!this.name_localizations) {
@@ -159,7 +159,7 @@ export class ContextMenuCommandBuilder {
 	/**
 	 * Sets the name localizations
 	 *
-	 * @param localizedNames The dictionary of localized descriptions to set
+	 * @param localizedNames - The dictionary of localized descriptions to set
 	 */
 	public setNameLocalizations(localizedNames: LocalizationMap | null) {
 		if (localizedNames === null) {
--- a/packages/builders/src/interactions/modals/UnsafeModal.ts
+++ b/packages/builders/src/interactions/modals/UnsafeModal.ts
@@ -18,7 +18,8 @@ export class UnsafeModalBuilder implements JSONEncodable<APIModalInteractionResp

 	/**
 	 * Sets the title of the modal
-	 * @param title The title of the modal
+	 *
+	 * @param title - The title of the modal
 	 */
 	public setTitle(title: string) {
 		this.data.title = title;
@@ -27,7 +28,8 @@ export class UnsafeModalBuilder implements JSONEncodable<APIModalInteractionResp

 	/**
 	 * Sets the custom id of the modal
-	 * @param customId The custom id of this modal
+	 *
+	 * @param customId - The custom id of this modal
 	 */
 	public setCustomId(customId: string) {
 		this.data.custom_id = customId;
@@ -36,7 +38,8 @@ export class UnsafeModalBuilder implements JSONEncodable<APIModalInteractionResp

 	/**
 	 * Adds components to this modal
-	 * @param components The components to add to this modal
+	 *
+	 * @param components - The components to add to this modal
 	 */
 	public addComponents(
 		...components: RestOrArray<
@@ -55,7 +58,8 @@ export class UnsafeModalBuilder implements JSONEncodable<APIModalInteractionResp

 	/**
 	 * Sets the components in this modal
-	 * @param components The components to set this modal to
+	 *
+	 * @param components - The components to set this modal to
 	 */
 	public setComponents(...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder>>) {
 		this.components.splice(0, this.components.length, ...normalizeArray(components));
--- a/packages/builders/src/interactions/slashCommands/SlashCommandBuilder.ts
+++ b/packages/builders/src/interactions/slashCommands/SlashCommandBuilder.ts
@@ -86,7 +86,7 @@ export class SlashCommandBuilder {
 	 *
 	 * **Note**: If set to `false`, you will have to later `PUT` the permissions for this command.
 	 *
-	 * @param value Whether or not to enable this command by default
+	 * @param value - Whether or not to enable this command by default
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 * @deprecated Use `setDefaultMemberPermissions` or `setDMPermission` instead.
@@ -105,7 +105,7 @@ export class SlashCommandBuilder {
 	 *
 	 * **Note:** You can set this to `'0'` to disable the command by default.
 	 *
-	 * @param permissions The permissions bit field to set
+	 * @param permissions - The permissions bit field to set
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 */
@@ -122,7 +122,7 @@ export class SlashCommandBuilder {
 	 * Sets if the command is available in DMs with the application, only for globally-scoped commands.
 	 * By default, commands are visible.
 	 *
-	 * @param enabled If the command should be enabled in DMs
+	 * @param enabled - If the command should be enabled in DMs
 	 *
 	 * @see https://discord.com/developers/docs/interactions/application-commands#permissions
 	 */
@@ -138,7 +138,7 @@ export class SlashCommandBuilder {
 	/**
 	 * Adds a new subcommand group to this command
 	 *
-	 * @param input A function that returns a subcommand group builder, or an already built builder
+	 * @param input - A function that returns a subcommand group builder, or an already built builder
 	 */
 	public addSubcommandGroup(
 		input:
@@ -164,7 +164,7 @@ export class SlashCommandBuilder {
 	/**
 	 * Adds a new subcommand to this command
 	 *
-	 * @param input A function that returns a subcommand builder, or an already built builder
+	 * @param input - A function that returns a subcommand builder, or an already built builder
 	 */
 	public addSubcommand(
 		input:
--- a/packages/builders/src/interactions/slashCommands/SlashCommandSubcommands.ts
+++ b/packages/builders/src/interactions/slashCommands/SlashCommandSubcommands.ts
@@ -35,7 +35,7 @@ export class SlashCommandSubcommandGroupBuilder implements ToAPIApplicationComma
 	/**
 	 * Adds a new subcommand to this group
 	 *
-	 * @param input A function that returns a subcommand builder, or an already built builder
+	 * @param input - A function that returns a subcommand builder, or an already built builder
 	 */
 	public addSubcommand(
 		input:
--- a/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandNumericOptionMinMaxValueMixin.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandNumericOptionMinMaxValueMixin.ts
@@ -4,13 +4,15 @@ export abstract class ApplicationCommandNumericOptionMinMaxValueMixin {

 	/**
 	 * Sets the maximum number value of this option
-	 * @param max The maximum value this option can be
+	 *
+	 * @param max - The maximum value this option can be
 	 */
 	public abstract setMaxValue(max: number): this;

 	/**
 	 * Sets the minimum number value of this option
-	 * @param min The minimum value this option can be
+	 *
+	 * @param min - The minimum value this option can be
 	 */
 	public abstract setMinValue(min: number): this;
 }
--- a/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionBase.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionBase.ts
@@ -10,7 +10,7 @@ export abstract class ApplicationCommandOptionBase extends SharedNameAndDescript
 	/**
 	 * Marks the option as required
 	 *
-	 * @param required If this option should be required
+	 * @param required - If this option should be required
 	 */
 	public setRequired(required: boolean) {
 		// Assert that you actually passed a boolean
--- a/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionChannelTypesMixin.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionChannelTypesMixin.ts
@@ -23,7 +23,7 @@ export class ApplicationCommandOptionChannelTypesMixin {
 	/**
 	 * Adds channel types to this option
 	 *
-	 * @param channelTypes The channel types to add
+	 * @param channelTypes - The channel types to add
 	 */
 	public addChannelTypes(...channelTypes: ApplicationCommandOptionAllowedChannelTypes[]) {
 		if (this.channel_types === undefined) {
--- a/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionWithChoicesAndAutocompleteMixin.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/ApplicationCommandOptionWithChoicesAndAutocompleteMixin.ts
@@ -21,7 +21,7 @@ export class ApplicationCommandOptionWithChoicesAndAutocompleteMixin<T extends s
 	/**
 	 * Adds multiple choices for this option
 	 *
-	 * @param choices The choices to add
+	 * @param choices - The choices to add
 	 */
 	public addChoices(...choices: APIApplicationCommandOptionChoice<T>[]): this {
 		if (choices.length > 0 && this.autocomplete) {
@@ -65,7 +65,7 @@ export class ApplicationCommandOptionWithChoicesAndAutocompleteMixin<T extends s

 	/**
 	 * Marks the option as autocompletable
-	 * @param autocomplete If this option should be autocompletable
+	 * @param autocomplete - If this option should be autocompletable
 	 */
 	public setAutocomplete(autocomplete: boolean): this {
 		// Assert that you actually passed a boolean
--- a/packages/builders/src/interactions/slashCommands/mixins/NameAndDescription.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/NameAndDescription.ts
@@ -10,7 +10,7 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets the name
 	 *
-	 * @param name The name
+	 * @param name - The name
 	 */
 	public setName(name: string): this {
 		// Assert the name matches the conditions
@@ -24,7 +24,7 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets the description
 	 *
-	 * @param description The description
+	 * @param description - The description
 	 */
 	public setDescription(description: string) {
 		// Assert the description matches the conditions
@@ -38,8 +38,8 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets a name localization
 	 *
-	 * @param locale The locale to set a description for
-	 * @param localizedName The localized description for the given locale
+	 * @param locale - The locale to set a description for
+	 * @param localizedName - The localized description for the given locale
 	 */
 	public setNameLocalization(locale: LocaleString, localizedName: string | null) {
 		if (!this.name_localizations) {
@@ -62,7 +62,7 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets the name localizations
 	 *
-	 * @param localizedNames The dictionary of localized descriptions to set
+	 * @param localizedNames - The dictionary of localized descriptions to set
 	 */
 	public setNameLocalizations(localizedNames: LocalizationMap | null) {
 		if (localizedNames === null) {
@@ -81,8 +81,8 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets a description localization
 	 *
-	 * @param locale The locale to set a description for
-	 * @param localizedDescription The localized description for the given locale
+	 * @param locale - The locale to set a description for
+	 * @param localizedDescription - The localized description for the given locale
 	 */
 	public setDescriptionLocalization(locale: LocaleString, localizedDescription: string | null) {
 		if (!this.description_localizations) {
@@ -105,7 +105,7 @@ export class SharedNameAndDescription {
 	/**
 	 * Sets the description localizations
 	 *
-	 * @param localizedDescriptions The dictionary of localized descriptions to set
+	 * @param localizedDescriptions - The dictionary of localized descriptions to set
 	 */
 	public setDescriptionLocalizations(localizedDescriptions: LocalizationMap | null) {
 		if (localizedDescriptions === null) {
--- a/packages/builders/src/interactions/slashCommands/mixins/SharedSlashCommandOptions.ts
+++ b/packages/builders/src/interactions/slashCommands/mixins/SharedSlashCommandOptions.ts
@@ -17,7 +17,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a boolean option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addBooleanOption(
 		input: SlashCommandBooleanOption | ((builder: SlashCommandBooleanOption) => SlashCommandBooleanOption),
@@ -28,7 +28,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a user option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addUserOption(input: SlashCommandUserOption | ((builder: SlashCommandUserOption) => SlashCommandUserOption)) {
 		return this._sharedAddOptionMethod(input, SlashCommandUserOption);
@@ -37,7 +37,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a channel option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addChannelOption(
 		input: SlashCommandChannelOption | ((builder: SlashCommandChannelOption) => SlashCommandChannelOption),
@@ -48,7 +48,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a role option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addRoleOption(input: SlashCommandRoleOption | ((builder: SlashCommandRoleOption) => SlashCommandRoleOption)) {
 		return this._sharedAddOptionMethod(input, SlashCommandRoleOption);
@@ -57,7 +57,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds an attachment option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addAttachmentOption(
 		input: SlashCommandAttachmentOption | ((builder: SlashCommandAttachmentOption) => SlashCommandAttachmentOption),
@@ -68,7 +68,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a mentionable option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addMentionableOption(
 		input: SlashCommandMentionableOption | ((builder: SlashCommandMentionableOption) => SlashCommandMentionableOption),
@@ -79,7 +79,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a string option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addStringOption(
 		input:
@@ -99,7 +99,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds an integer option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addIntegerOption(
 		input:
@@ -119,7 +119,7 @@ export class SharedSlashCommandOptions<ShouldOmitSubcommandFunctions = true> {
 	/**
 	 * Adds a number option
 	 *
-	 * @param input A function that returns an option builder, or an already built builder
+	 * @param input - A function that returns an option builder, or an already built builder
 	 */
 	public addNumberOption(
 		input: