Interface LengthOptions

Represents numeric and string Brynjolf arguments that support ranged value limits, choices, and autocompletion.

interface LengthOptions {
    autocomplete?: ((data) => any);
    choices?: string[] | number[];
    desc: string;
    localDesc?: 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>>;
    localName?: 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>>;
    name: string;
    range?: [number?, number?];
    req?: boolean;
}

Hierarchy (view full)

Properties

autocomplete? choices? desc localDesc? localName? name range? req?

Properties

Optional autocomplete

autocomplete?: ((data) => any)

Argument autocompletion handler.

Type declaration

    • (data): any

    • Parameters

      • data: any

      Returns any

Optional choices

choices?: string[] | number[]

List of possible argument value choices.

desc

desc: string

Description of the argument.

Optional localDesc

localDesc?: 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 localName

localName?: 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.

name

name: string

Name of the argument.

Optional range

range?: [number?, number?]

Minimum and/or maximum argument values/lengths.

Optional req

req?: boolean

Whether the argument is required.

Settings

Member Visibility

Theme

On This Page

autocompletechoicesdesclocalDesclocalNamenamerangereq

Generated using TypeDoc