Class MenuInputConfigs

Index

Constructors

Methods

isClear setClear isFastSubmit setFastSubmit isInline setInline getForbidChars setForbidChars getValidate setValidate getCallback setCallback toJson

Properties

clear fastSubmit inline forbidChars? validate? callback?

Constructors

constructor

new MenuInputConfigs(data?: MenuInputConfigsJson): MenuInputConfigs
Creates a new MenuInputConfigs with defaults.
Parameters
- Optionaldata: MenuInputConfigsJson
  Optional JSON object with clear, fastSubmit, inline, validate, and callback.
Returns MenuInputConfigs
- Defined in menus/input/config.ts:25

Methods

isClear

isClear(): boolean | undefined
Returns true when the screen is cleared before rendering the input prompt.

Returns boolean | undefined
- Defined in menus/input/config.ts:37

setClear

setClear(v: NonNullable<boolean | undefined>): this
Sets whether the screen is cleared before rendering the prompt.
Parameters
- v: NonNullable<boolean | undefined>
Returns this
- Defined in menus/input/config.ts:42

isFastSubmit

isFastSubmit(): boolean | undefined
Returns true when Enter is not required to submit (submits on single character).

Returns boolean | undefined
- Defined in menus/input/config.ts:48

setFastSubmit

setFastSubmit(v: NonNullable<boolean | undefined>): this
Sets whether the prompt submits on the first character typed.
Parameters
- v: NonNullable<boolean | undefined>
Returns this
- Defined in menus/input/config.ts:53

isInline

isInline(): boolean | undefined
Returns true when the input is rendered inline (no full-screen takeover).

Returns boolean | undefined
- Defined in menus/input/config.ts:59

setInline

setInline(v: NonNullable<boolean | undefined>): this
Sets whether the prompt is rendered inline.
Parameters
- v: NonNullable<boolean | undefined>
Returns this
- Defined in menus/input/config.ts:64

getForbidChars

getForbidChars(): string | undefined
Returns a string with characters that should be blocked while typing, or undefined.

Returns string | undefined
- Defined in menus/input/config.ts:70

setForbidChars

setForbidChars(v: string | undefined): this
Sets characters that should be blocked while typing (e.g. a single space ' ').
Parameters
- v: string | undefined
Returns this
- Defined in menus/input/config.ts:75

getValidate

getValidate(): ((value: string) => string | boolean) | undefined
Returns the validation function, or undefined if not configured.

Returns ((value: string) => string | boolean) | undefined
- Defined in menus/input/config.ts:81

setValidate

setValidate(v: ((value: string) => string | boolean) | undefined): this
Sets a custom validation function for the input value. Return true to accept, a string to display as error, or false to show the generic error label.
Parameters
- v: ((value: string) => string | boolean) | undefined
Returns this
- Defined in menus/input/config.ts:89

getCallback

getCallback(): | (
    (
        data: {
            menu: MenuInput;
            value: string;
            language?: string;
            parent?: string;
        },
    ) => Promise<void>
)
| undefined
Returns the submission callback, or undefined if not configured.

Returns
    | (
        (
            data: {
                menu: MenuInput;
                value: string;
                language?: string;
                parent?: string;
            },
        ) => Promise<void>
    )
    | undefined
- Defined in menus/input/config.ts:95

setCallback

setCallback(
    v:
        | (
            (
                data: {
                    menu: MenuInput;
                    value: string;
                    language?: string;
                    parent?: string;
                },
            ) => Promise<void>
        )
        | undefined,
): this
Sets the callback invoked after successful submission.
Parameters
- v:
      | (
          (
              data: {
                  menu: MenuInput;
                  value: string;
                  language?: string;
                  parent?: string;
              },
          ) => Promise<void>
      )
      | undefined
  Async callback receiving the menu and submitted value.
Returns this
- Defined in menus/input/config.ts:103

toJson

toJson(): MenuInputConfigsJson
Serialises the config to a plain JSON-compatible object.

Returns MenuInputConfigsJson
- Defined in menus/input/config.ts:109

Properties

`Protected`clear

clear: NonNullable<boolean | undefined> = true

`Protected`fastSubmit

fastSubmit: NonNullable<boolean | undefined> = false

`Protected`inline

inline: NonNullable<boolean | undefined> = false

`Protected` `Optional`forbidChars

forbidChars?: string

`Protected` `Optional`validate

validate?: (value: string) => string | boolean

`Protected` `Optional`callback

callback?: (
    data: {
        menu: MenuInput;
        value: string;
        language?: string;
        parent?: string;
    },
) => Promise<void>

Class MenuInputConfigs

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuInputConfigs

Methods

isClear

Returns boolean | undefined

setClear

Parameters

Returns this

isFastSubmit

Returns boolean | undefined

setFastSubmit

Parameters

Returns this

isInline

Returns boolean | undefined

setInline

Parameters

Returns this

getForbidChars

Returns string | undefined

setForbidChars

Parameters

Returns this

getValidate

Returns ((value: string) => string | boolean) | undefined

setValidate

Parameters

Returns this

getCallback

Returns | ( ( data: { menu: MenuInput; value: string; language?: string; parent?: string; }, ) => Promise<void> ) | undefined

setCallback

Parameters

Returns this

toJson

Returns MenuInputConfigsJson

Properties

Protectedclear

ProtectedfastSubmit

Protectedinline

Protected OptionalforbidChars

Protected Optionalvalidate

Protected Optionalcallback

Settings

On This Page

Returns
| (
(
data: {
menu: MenuInput;
value: string;
language?: string;
parent?: string;
},
) => Promise<void>
)
| undefined

`Protected`clear

`Protected`fastSubmit

`Protected`inline

`Protected` `Optional`forbidChars

`Protected` `Optional`validate

`Protected` `Optional`callback