Skip to content
botflarev0.1.1

OptionConfig

OptionConfig<T, R, C> = object & OptionLimits<T> & object

Defined in: option.ts:24

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T extends keyof OptionValue

R

Section titled “R”

R extends boolean

C

Section titled “C”

C

Type Declaration

Section titled “Type Declaration”

choices?

Section titled “choices?”

optional choices?: C

The only values the user can pick, keyed by the label Discord shows. For a string, integer or number option.

description

Section titled “description”

description: string

The text Discord shows under the option name.

locales?

Section titled “locales?”

optional locales?: Locales

The name and description in other languages, keyed by Discord locale.

required?

Section titled “required?”

optional required?: R

Whether the user must fill it in. Defaults to false.

autocomplete?

Section titled “autocomplete?”

optional autocomplete?: [Choice<T>] extends [never] ? never : [C] extends [never] ? (c) => Suggestion<Choice<T>>[] | Promise<Suggestion<Choice<T>>[]> : never

Suggests values as the user types, instead of fixed choices. Gets what the user has typed so far as c.value and returns up to 25 suggestions, as plain values or as { name, value }.