Class MenuItemCreator

Builds one menu step used by MenuCreator.item.

Index

Constructors

Methods

build inputMethods inputTimeoutDurationSeconds match maximumInputLength minimumInputLength onFailure prompt repeatCount repeatPrompt terminatingSequence

Constructors

constructor

new MenuItemCreator(): MenuItemCreator
Returns MenuItemCreator

Methods

build

build(): MenuItem
Returns MenuItem

inputMethods

inputMethods(inputMethods: string[]): this
Parameters
- inputMethods: string[]
Returns this

inputTimeoutDurationSeconds

inputTimeoutDurationSeconds(seconds: number): this
Parameters
- seconds: number
Returns this

match

match(expression: string, build: CommandInput): this
Stacks commands for one match expression. Calling again with the same expression appends.
Parameters
- expression: string
- build: CommandInput
Returns this

maximumInputLength

maximumInputLength(length: number): this
Parameters
- length: number
Returns this

minimumInputLength

minimumInputLength(length: number): this
Parameters
- length: number
Returns this

onFailure

onFailure(build: CommandInput): this
Maps to onFailure on the menu item.
Parameters
- build: CommandInput
Returns this

prompt

prompt(value: MenuPrompt | ((prompt: PromptCreator) => void)): this
Parameters
- value: MenuPrompt | ((prompt: PromptCreator) => void)
Returns this

repeatCount

repeatCount(count: number): this
Parameters
- count: number
Returns this

repeatPrompt

repeatPrompt(value: MenuPrompt | ((prompt: PromptCreator) => void)): this
Parameters
- value: MenuPrompt | ((prompt: PromptCreator) => void)
Returns this

terminatingSequence

terminatingSequence(sequence: string): this
Parameters
- sequence: string
Returns this