Interface ResultOptions

Discord API-compatible object capable of representing arguments, subcommands, and subgroups. This is the output of Brynjolf's argument translation.

interface ResultOptions {
    _brynjolf_type: string;
    autocomplete?: boolean;
    channel_types?: ChannelType[];
    choices?: {
        [choice: string]: any;
    }[];
    description?: string;
    description_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>;
    max_length?: number;
    max_value?: number;
    min_length?: number;
    min_value?: number;
    name?: string;
    name_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>;
    options?: ResultOptions[];
    required?: boolean;
    type: ApplicationCommandOptionType;
}

Properties

_brynjolf_type autocomplete? channel_types? choices? description? description_localizations? max_length? max_value? min_length? min_value? name? name_localizations? options? required? type

Properties

Private _brynjolf_type

_brynjolf_type: string

The string name of the argument type, for internal use.

Optional autocomplete

autocomplete?: boolean

Whether to enable argument autocompletion.

Optional channel_types

channel_types?: ChannelType[]

Possible types allowed in channel arguments.

Optional choices

choices?: {
    [choice: string]: any;
}[]

Map of possible argument value choices.

Type declaration

  • [choice: string]: any

Optional description

description?: string

Description of the argument.

Optional description_localizations

description_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

Map of locales to localized argument descriptions.

Optional max_length

max_length?: number

Maximum string argument length.

Optional max_value

max_value?: number

Maximum numeric argument value.

Optional min_length

min_length?: number

Minimum string argument length.

Optional min_value

min_value?: number

Minimum numeric argument value.

Optional name

name?: string

Name of the argument.

Optional name_localizations

name_localizations?: Partial<Record<"id" | "en-US" | "en-GB" | "bg" | "zh-CN" | "zh-TW" | "hr" | "cs" | "da" | "nl" | "fi" | "fr" | "de" | "el" | "hi" | "hu" | "it" | "ja" | "ko" | "lt" | "no" | "pl" | "pt-BR" | "ro" | "ru" | "es-ES" | "es-419" | "sv-SE" | "th" | "tr" | "uk" | "vi", null | string>>

Map of locales to localized argument names.

Optional options

options?: ResultOptions[]

List of subarguments of the subcommand or subgroup.

Optional required

required?: boolean

Whether the argument is required.

type

type: ApplicationCommandOptionType

The type of argument.

Settings

Member Visibility

Theme

On This Page

_brynjolf_typeautocompletechannel_typeschoicesdescriptiondescription_localizationsmax_lengthmax_valuemin_lengthmin_valuenamename_localizationsoptionsrequiredtype

Generated using TypeDoc