mirror of
https://github.com/discordjs/discord.js.git
synced 2026-05-28 06:20:10 +00:00
docs(SelectMenuBuilder): correct documentation Corrects gramatical errors in the documentation for various set methods. Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
78 lines
2.1 KiB
TypeScript
78 lines
2.1 KiB
TypeScript
import {
|
|
type APIRoleSelectComponent,
|
|
type Snowflake,
|
|
ComponentType,
|
|
SelectMenuDefaultValueType,
|
|
} from 'discord-api-types/v10';
|
|
import { type RestOrArray, normalizeArray } from '../../util/normalizeArray.js';
|
|
import { optionsLengthValidator } from '../Assertions.js';
|
|
import { BaseSelectMenuBuilder } from './BaseSelectMenu.js';
|
|
|
|
/**
|
|
* A builder that creates API-compatible JSON data for role select menus.
|
|
*/
|
|
export class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent> {
|
|
/**
|
|
* 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 RoleSelectMenuBuilder({
|
|
* custom_id: 'a cool select menu',
|
|
* placeholder: 'select an option',
|
|
* max_values: 2,
|
|
* });
|
|
* ```
|
|
* @example
|
|
* Creating a select menu using setters and API data:
|
|
* ```ts
|
|
* const selectMenu = new RoleSelectMenuBuilder({
|
|
* custom_id: 'a cool select menu',
|
|
* })
|
|
* .setMinValues(1);
|
|
* ```
|
|
*/
|
|
public constructor(data?: Partial<APIRoleSelectComponent>) {
|
|
super({ ...data, type: ComponentType.RoleSelect });
|
|
}
|
|
|
|
/**
|
|
* Adds default roles to this auto populated select menu.
|
|
*
|
|
* @param roles - The roles to add
|
|
*/
|
|
public addDefaultRoles(...roles: RestOrArray<Snowflake>) {
|
|
const normalizedValues = normalizeArray(roles);
|
|
optionsLengthValidator.parse((this.data.default_values?.length ?? 0) + normalizedValues.length);
|
|
this.data.default_values ??= [];
|
|
|
|
this.data.default_values.push(
|
|
...normalizedValues.map((id) => ({
|
|
id,
|
|
type: SelectMenuDefaultValueType.Role as const,
|
|
})),
|
|
);
|
|
|
|
return this;
|
|
}
|
|
|
|
/**
|
|
* Sets default roles for this auto populated select menu.
|
|
*
|
|
* @param roles - The roles to set
|
|
*/
|
|
public setDefaultRoles(...roles: RestOrArray<Snowflake>) {
|
|
const normalizedValues = normalizeArray(roles);
|
|
optionsLengthValidator.parse(normalizedValues.length);
|
|
|
|
this.data.default_values = normalizedValues.map((id) => ({
|
|
id,
|
|
type: SelectMenuDefaultValueType.Role as const,
|
|
}));
|
|
|
|
return this;
|
|
}
|
|
}
|