@discordjs/builders 1.2.1-dev.1663502665-669c3cd.0 → 1.2.1-dev.1663589061-145eb2f.0

package/dist/index.d.ts

@@ -539,6 +539,28 @@ declare function isJSONEncodable(maybeEncodable: unknown): maybeEncodable is JSO
  */
 declare class SelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOption> {
     data: Partial<APISelectMenuOption>;
+    /**
+     * Creates a new select menu option from API data
+     *
+     * @param data - The API data to create this select menu option with
+     * @example
+     * Creating a select menu option from an API data object
+     * ```ts
+     * const selectMenuOption = new SelectMenuOptionBuilder({
+     * 	label: 'catchy label',
+     * 	value: '1',
+     * });
+     * ```
+     * @example
+     * Creating a select menu option using setters and API data
+     * ```ts
+     * const selectMenuOption = new SelectMenuOptionBuilder({
+     * 	default: true,
+     * 	value: '1',
+     * })
+     * 	.setLabel('woah')
+     * ```
+     */
     constructor(data?: Partial<APISelectMenuOption>);
     /**
      * Sets the label of this option
@@ -694,24 +716,24 @@ declare class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
      * Creating a button from an API data object
      * ```ts
      * const button = new ButtonBuilder({
-     * 	style: 'primary',
+     * 	custom_id: 'a cool button',
+     * 	style: ButtonStyle.Primary,
      * 	label: 'Click Me',
      * 	emoji: {
-     * 		name: ':smile:',
-     * 		id: '12345678901234567890123456789012',
+     * 		name: 'smile',
+     * 		id: '123456789012345678',
      * 	},
-     *  custom_id: '12345678901234567890123456789012',
      * });
      * ```
      * @example
      * Creating a button using setters and API data
      * ```ts
      * const button = new ButtonBuilder({
-     * 	style: 'primary',
+     * 	style: ButtonStyle.Secondary,
      * 	label: 'Click Me',
      * })
-     * .setEmoji({ name: ':smile:', id: '12345678901234567890123456789012' })
-     * .setCustomId('12345678901234567890123456789012');
+     * 	.setEmoji({ name: '🙂' })
+     * 	.setCustomId('another cool button');
      * ```
      */
     constructor(data?: Partial<APIButtonComponent>);
@@ -770,6 +792,37 @@ declare class SelectMenuBuilder extends ComponentBuilder<APISelectMenuComponent>
      * The options within this select menu
      */
     readonly options: SelectMenuOptionBuilder[];
+    /**
+     * Creates a new select menu from API data
+     *
+     * @param data - The API data to create this select menu with
+     * @example
+     * Creating a select menu from an API data object
+     * ```ts
+     * const selectMenu = new SelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	placeholder: 'select an option',
+     * 	max_values: 2,
+     * 	options: [
+     * 		{ label: 'option 1', value: '1' },
+     * 		{ label: 'option 2', value: '2' },
+     * 		{ label: 'option 3', value: '3' },
+     * 	],
+     * });
+     * ```
+     * @example
+     * Creating a select menu using setters and API data
+     * ```ts
+     * const selectMenu = new SelectMenuBuilder({
+     * 	custom_id: 'a cool select menu',
+     * })
+     * 	.setMinValues(1)
+     * 	.addOptions({
+     * 		label: 'Catchy',
+     * 		value: 'catch',
+     * 	});
+     * ```
+     */
     constructor(data?: Partial<APISelectMenuComponent>);
     /**
      * Sets the placeholder for this select menu
@@ -840,6 +893,29 @@ interface Equatable<T> {
 declare function isEquatable(maybeEquatable: unknown): maybeEquatable is Equatable<unknown>;
 
 declare class TextInputBuilder extends ComponentBuilder<APITextInputComponent> implements Equatable<APITextInputComponent | JSONEncodable<APITextInputComponent>> {
+    /**
+     * Creates a new text input from API data
+     *
+     * @param data - The API data to create this text input with
+     * @example
+     * Creating a select menu option from an API data object
+     * ```ts
+     * const textInput = new TextInputBuilder({
+     * 	custom_id: 'a cool select menu',
+     * 	label: 'Type something',
+     * 	style: TextInputStyle.Short,
+     * });
+     * ```
+     * @example
+     * Creating a select menu option using setters and API data
+     * ```ts
+     * const textInput = new TextInputBuilder({
+     * 	label: 'Type something else',
+     * })
+     * 	.setCustomId('woah')
+     * 	.setStyle(TextInputStyle.Paragraph);
+     * ```
+     */
     constructor(data?: APITextInputComponent & {
         type?: ComponentType.TextInput;
     });
@@ -916,6 +992,40 @@ declare class ActionRowBuilder<T extends AnyComponentBuilder> extends ComponentB
      * The components within this action row
      */
     readonly components: T[];
+    /**
+     * Creates a new action row from API data
+     *
+     * @param data - The API data to create this action row with
+     * @example
+     * Creating an action row from an API data object
+     * ```ts
+     * const actionRow = new ActionRowBuilder({
+     * 	components: [
+     * 		{
+     * 			custom_id: "custom id",
+     * 			label: "Type something",
+     * 			style: TextInputStyle.Short,
+     * 			type: ComponentType.TextInput,
+     * 		},
+     * 	],
+     * });
+     * ```
+     * @example
+     * Creating an action row using setters and API data
+     * ```ts
+     * const actionRow = new ActionRowBuilder({
+     * 	components: [
+     * 		{
+     * 			custom_id: "custom id",
+     * 			label: "Click me",
+     * 			style: ButtonStyle.Primary,
+     * 			type: ComponentType.Button,
+     * 		},
+     * 	],
+     * })
+     * 	.addComponents(button2, button3);
+     * ```
+     */
     constructor({ components, ...data }?: Partial<APIActionRowComponent<APIActionRowComponentTypes>>);
     /**
      * Adds components to this action row.