feat(website): Show constructor information (#8540)

Author: suneettipirneni

packages/builders/.eslintrc.json

@@ -1,3 +1,7 @@
 {
-	"extends": "../../.eslintrc.json"
+	"extends": "../../.eslintrc.json",
+	"plugins": ["eslint-plugin-tsdoc"],
+	"rules": {
+		"tsdoc/syntax": "warn"
+	}
 }

packages/builders/package.json

@@ -74,6 +74,7 @@
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-import-resolver-typescript": "^3.4.1",
 		"eslint-plugin-import": "^2.26.0",
+		"eslint-plugin-tsdoc": "^0.2.16",
 		"prettier": "^2.7.1",
 		"rollup-plugin-typescript2": "0.32.1",
 		"typescript": "^4.7.4",

packages/builders/src/components/ActionRow.ts

@@ -59,7 +59,7 @@ export class ActionRowBuilder<T extends AnyComponentBuilder> extends ComponentBu
 	}
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * {@inheritDoc ComponentBuilder.toJSON}
 	 */
 	public toJSON(): APIActionRowComponent<ReturnType<T['toJSON']>> {
 		// eslint-disable-next-line @typescript-eslint/consistent-type-assertions

packages/builders/src/components/Component.ts

@@ -23,7 +23,11 @@ export abstract class ComponentBuilder<
 	public readonly data: Partial<DataType>;
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * Serializes this component to an API-compatible JSON object
+	 *
+	 * @remarks
+	 * This method runs validations on the data before serializing it.
+	 * As such, it may throw an error if the data is invalid.
 	 */
 	public abstract toJSON(): AnyAPIActionRowComponent;
 

packages/builders/src/components/button/Button.ts

@@ -21,6 +21,35 @@ import { ComponentBuilder } from '../Component';
  * Represents a button component
  */
 export class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
+	/**
+	 * Creates a new button from API data
+	 * @param data - The API data to create this button with
+	 *
+	 * @example
+	 * Creating a button from an API data object
+	 * ```ts
+	 * const button = new ButtonBuilder({
+	 * 	style: 'primary',
+	 * 	label: 'Click Me',
+	 * 	emoji: {
+	 * 		name: ':smile:',
+	 * 		id: '12345678901234567890123456789012',
+	 * 	},
+	 *  custom_id: '12345678901234567890123456789012',
+	 * });
+	 * ```
+	 *
+	 * @example
+	 * Creating a button using setters and API data
+	 * ```ts
+	 * const button = new ButtonBuilder({
+	 * 	style: 'primary',
+	 * 	label: 'Click Me',
+	 * })
+	 * .setEmoji({ name: ':smile:', id: '12345678901234567890123456789012' })
+	 * .setCustomId('12345678901234567890123456789012');
+	 * ```
+	 */
 	public constructor(data?: Partial<APIButtonComponent>) {
 		super({ type: ComponentType.Button, ...data });
 	}
@@ -38,6 +67,10 @@ export class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
 	/**
 	 * Sets the URL for this button
 	 *
+	 * @remarks
+	 * This method is only available to buttons using the `Link` button style.
+	 * Only three types of URL schemes are currently supported: `https://`, `http://` and `discord://`
+	 *
 	 * @param url - The URL to open when this button is clicked
 	 */
 	public setURL(url: string) {
@@ -48,6 +81,9 @@ export class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
 	/**
 	 * Sets the custom id for this button
 	 *
+	 * @remarks
+	 * This method is only applicable to buttons that are not using the `Link` button style.
+	 *
 	 * @param customId - The custom id to use for this button
 	 */
 	public setCustomId(customId: string) {
@@ -86,7 +122,7 @@ export class ButtonBuilder extends ComponentBuilder<APIButtonComponent> {
 	}
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * {@inheritDoc ComponentBuilder.toJSON}
 	 */
 	public toJSON(): APIButtonComponent {
 		validateRequiredButtonParameters(

packages/builders/src/components/selectMenu/SelectMenu.ts

@@ -117,7 +117,7 @@ export class SelectMenuBuilder extends ComponentBuilder<APISelectMenuComponent>
 	}
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * {@inheritDoc ComponentBuilder.toJSON}
 	 */
 	public toJSON(): APISelectMenuComponent {
 		validateRequiredSelectMenuParameters(this.options, this.data.custom_id);

packages/builders/src/components/selectMenu/SelectMenuOption.ts

@@ -65,7 +65,7 @@ export class SelectMenuOptionBuilder implements JSONEncodable<APISelectMenuOptio
 	}
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * {@inheritDoc ComponentBuilder.toJSON}
 	 */
 	public toJSON(): APISelectMenuOption {
 		validateRequiredSelectMenuOptionParameters(this.data.label, this.data.value);

packages/builders/src/components/textInput/TextInput.ts

@@ -104,7 +104,7 @@ export class TextInputBuilder
 	}
 
 	/**
-	 * {@inheritDoc JSONEncodable.toJSON}
+	 * {@inheritDoc ComponentBuilder.toJSON}
 	 */
 	public toJSON(): APITextInputComponent {
 		validateRequiredParameters(this.data.custom_id, this.data.style, this.data.label);

packages/builders/src/interactions/contextMenuCommands/ContextMenuCommandBuilder.ts

@@ -35,7 +35,7 @@ export class ContextMenuCommandBuilder {
 	 * Whether the command is enabled by default when the app is added to a guild
 	 *
 	 * @deprecated This property is deprecated and will be removed in the future.
-	 * You should use `setDefaultMemberPermissions` or `setDMPermission` instead.
+	 * You should use {@link ContextMenuCommandBuilder.setDefaultMemberPermissions} or {@link ContextMenuCommandBuilder.setDMPermission} instead.
 	 */
 	public readonly default_permission: boolean | undefined = undefined;
 
@@ -86,7 +86,7 @@ export class ContextMenuCommandBuilder {
 	 * @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.
+	 * @deprecated Use {@link ContextMenuCommandBuilder.setDefaultMemberPermissions} or {@link ContextMenuCommandBuilder.setDMPermission} instead.
 	 */
 	public setDefaultPermission(value: boolean) {
 		// Assert the value matches the conditions

packages/builders/src/interactions/modals/Modal.ts

@@ -70,6 +70,9 @@ export class ModalBuilder implements JSONEncodable<APIModalInteractionResponseCa
 		return this;
 	}
 
+	/**
+	 * {@inheritDoc ComponentBuilder.toJSON}
+	 */
 	public toJSON(): APIModalInteractionResponseCallbackData {
 		validateRequiredParameters(this.data.custom_id, this.data.title, this.components);
 		// eslint-disable-next-line @typescript-eslint/consistent-type-assertions