Class MenuEditorConfigs

Index

Constructors

Methods

isClear setClear getPostfix setPostfix isWaitForUserInput setWaitForUserInput getValidate setValidate getCallback setCallback toJson

Properties

clear postfix waitForUserInput validate? callback?

Constructors

constructor

new MenuEditorConfigs(data?: MenuEditorConfigsJson): MenuEditorConfigs
Creates a new MenuEditorConfigs with defaults.
Parameters
- Optionaldata: MenuEditorConfigsJson
  Optional JSON with clear, postfix, waitForUserInput, validate, and callback.
Returns MenuEditorConfigs
- Defined in menus/editor/config.ts:22

Methods

isClear

isClear(): boolean | undefined
Returns true when the screen is cleared before opening the editor.

Returns boolean | undefined
- Defined in menus/editor/config.ts:33

setClear

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

getPostfix

getPostfix(): string
Returns the file extension postfix used for the temp file (e.g. ".env").

Returns string
- Defined in menus/editor/config.ts:44

setPostfix

setPostfix(v: string): this
Sets the file extension postfix for the temp file.
Parameters
- v: string
Returns this
- Defined in menus/editor/config.ts:49

isWaitForUserInput

isWaitForUserInput(): NonNullable<boolean | undefined>
Returns true when the editor waits for user confirmation before opening.

Returns NonNullable<boolean | undefined>
- Defined in menus/editor/config.ts:55

setWaitForUserInput

setWaitForUserInput(v: NonNullable<boolean | undefined>): this
Sets whether the prompt waits for a keypress before opening the editor.
Parameters
- v: NonNullable<boolean | undefined>
Returns this
- Defined in menus/editor/config.ts:60

getValidate

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

Returns ((value: string) => string | boolean | Promise<string | boolean>) | undefined
- Defined in menus/editor/config.ts:66

setValidate

setValidate(
    v:
        | ((value: string) => string | boolean | Promise<string | boolean>)
        | undefined,
): this
Sets a custom validation function for the editor content.
Parameters
- v: ((value: string) => string | boolean | Promise<string | boolean>) | undefined
Returns this
- Defined in menus/editor/config.ts:71

getCallback

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

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

setCallback

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

toJson

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

Returns MenuEditorConfigsJson
- Defined in menus/editor/config.ts:88

Properties

`Protected`clear

clear: NonNullable<boolean | undefined> = true

`Protected`postfix

postfix: string = ".env"

`Protected`waitForUserInput

waitForUserInput: NonNullable<boolean | undefined> = true

`Protected` `Optional`validate

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

`Protected` `Optional`callback

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

Class MenuEditorConfigs

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns MenuEditorConfigs

Methods

isClear

Returns boolean | undefined

setClear

Parameters

Returns this

getPostfix

Returns string

setPostfix

Parameters

Returns this

isWaitForUserInput

Returns NonNullable<boolean | undefined>

setWaitForUserInput

Parameters

Returns this

getValidate

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

setValidate

Parameters

Returns this

getCallback

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

setCallback

Parameters

Returns this

toJson

Returns MenuEditorConfigsJson

Properties

Protectedclear

Protectedpostfix

ProtectedwaitForUserInput

Protected Optionalvalidate

Protected Optionalcallback

Settings

On This Page

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

`Protected`clear

`Protected`postfix

`Protected`waitForUserInput

`Protected` `Optional`validate

`Protected` `Optional`callback