discord.js/packages/structures/src/messages/components/StringSelectMenuOption.ts

import type { APISelectMenuOption } from 'discord-api-types/v10';
import { Structure } from '../../Structure.js';
import { kData } from '../../utils/symbols.js';
import type { Partialize } from '../../utils/types.js';

/**
 * Represents an option in a string select menu component.
 *
 * @typeParam Omitted - Specify the properties that will not be stored in the raw data field as a union, implement via `DataTemplate`
 * @remarks has a substructure `ComponentEmoji` which needs to be instantiated and stored by an extending class using it
 */
export class StringSelectMenuOption<Omitted extends keyof APISelectMenuOption | '' = ''> extends Structure<
	APISelectMenuOption,
	Omitted
> {
	/**
	 * The template used for removing data from the raw data stored for each StringSelectMenuOption.
	 */
	public static override readonly DataTemplate: Partial<APISelectMenuOption> = {};

	/**
	 * @param data - The raw data received from the API for the string select menu option
	 */
	public constructor(data: Partialize<APISelectMenuOption, Omitted>) {
		super(data);
	}

	/**
	 * Whether this option should be already-selected by default
	 */
	public get default() {
		return this[kData].default;
	}

	/**
	 * An additional description of the option
	 */
	public get description() {
		return this[kData].description;
	}

	/**
	 * The user-facing name of the option
	 */
	public get label() {
		return this[kData].label;
	}

	/**
	 * The dev-defined value of the option
	 */
	public get value() {
		return this[kData].value;
	}
}