Interface AutoCompleteOptions<T>

interface AutoCompleteOptions<T> {
    choices?: APIApplicationCommandOptionChoice<string>[];
    description: string;
    lowercaseQuery?: boolean;
    maxLength?: number;
    minLength?: number;
    name: string;
    required?: boolean;
    resolveValue?: T extends undefined
        ? undefined
        : AutoCompleteGetValueFunction<T>;
    run: AutoCompleteRunFunction;
    suppressUnknownInteractionErrors?: boolean;
    trimQuery?: boolean;
}

Type Parameters

  • T = undefined

Properties

choices? description lowercaseQuery? maxLength? minLength? name required? resolveValue? run suppressUnknownInteractionErrors? trimQuery?

Properties

Optional choices

choices?: APIApplicationCommandOptionChoice<string>[]

The choices for this auto-complete option.

description

description: string

The description for this auto-complete option.

Optional lowercaseQuery

lowercaseQuery?: boolean

Should the query be lowercased before being passed to the run function?

Optional maxLength

maxLength?: number

The maximum length for the auto-complete option.

Optional minLength

minLength?: number

The minimum length for the auto-complete option.

name

name: string

The name for this auto-complete option, this should be unique.

Optional required

required?: boolean

Whether this auto-complete option is required.

Optional resolveValue

resolveValue?: T extends undefined
    ? undefined
    : AutoCompleteGetValueFunction<T>

The function that gets the resolved value of the auto-complete option. Returns raw value by default.

run

run: AutoCompleteRunFunction

The function that responds to the auto-complete option.

Optional suppressUnknownInteractionErrors

suppressUnknownInteractionErrors?: boolean

Should warnings about Unknown Interaction errors be suppressed?

Optional trimQuery

trimQuery?: boolean

Should the query be trimmed before being passed to the run function?

Settings

Member Visibility

Theme

On This Page

choicesdescriptionlowercaseQuerymaxLengthminLengthnamerequiredresolveValuerunsuppressUnknownInteractionErrorstrimQuery