@hunteroi/discord-form
    Preparing search index...

    Interface StringSelectMenuFormEntry

    A form entry using a string select menu component. Allows users to choose from a predefined list of options.

    interface StringSelectMenuFormEntry {
        answer?: string | string[];
        componentType: "string_select";
        customId: string;
        description?: string;
        label: string;
        options: {
            default?: boolean;
            description?: string;
            emoji?: string;
            label: string;
            value: string;
        }[];
        parser: (answer: string | string[]) => string | string[];
        raw?: string | string[];
        responseType: "string" | "string_array";
    }

    Hierarchy (View Summary)

    • FormEntryBase<string | string[]>
    • Omit<
          StringSelectMenuComponentData,
          "customId"
          | "options"
          | "type"
          | "channel_types",
      >
      • StringSelectMenuFormEntry
    Index

    Properties

    answer? componentType customId description? label options parser raw? responseType

    Properties

    answer?: string | string[]

    The parsed answer with proper typing.

    FormEntryBase

    componentType: "string_select"

    The component type identifier.

    StringSelectMenuFormEntry

    customId: string

    The unique identifier for this form entry.

    FormEntryBase

    description?: string

    Optional description to provide additional context. Max 100 characters. Displayed under the label.

    FormEntryBase

    label: string

    The label displayed to the user. For text inputs and file uploads: shown in the label component For select menus: shown in the label component

    FormEntryBase

    options: {
        default?: boolean;
        description?: string;
        emoji?: string;
        label: string;
        value: string;
    }[]

    The available options for selection. Must contain between 1 and 25 options.

    StringSelectMenuFormEntry

    parser: (answer: string | string[]) => string | string[]

    The parser function to transform the response(s) to the proper type.

    FormEntryBase

    raw?: string | string[]

    The raw value(s) of the entry as returned by Discord.

    FormEntryBase

    responseType: "string" | "string_array"

    The expected response type. 'string' for single select, 'string_array' for multi-select.

    StringSelectMenuFormEntry

    Settings

    Member Visibility

    On This Page

    Properties