Class InputHelper

Hierarchy

InputHelper

Index

Properties

Accessors

types

Methods

Properties

Protected _config

_config: Config

config

config: HelperOptionsConfig

Accessors

types

get types(): QuestionType[]

- Defined in src/helpers/helper.input.ts:31
Returns QuestionType[]

Methods

ask

ask(message: MessageType, def?: string): Promise<string>

- Defined in src/helpers/helper.input.ts:45
Parameters
- message: MessageType
- Optional def: string
Returns Promise<string>

autocomplete

autocomplete(message: MessageType, source: string[] | SourceType, suggestOnly?: boolean, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:74
Parameters
- message: MessageType
- source: string[] | SourceType
- Default value suggestOnly: boolean = false
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

checkbox

checkbox(msg: MessageType, choices: ChoiceType[] | Array<ChoiceOption>, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:66
Parameters
- msg: MessageType
- choices: ChoiceType[] | Array<ChoiceOption>
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

confirm

confirm(message: MessageType, def?: string): Promise<boolean>

- Defined in src/helpers/helper.input.ts:50
Parameters
- message: MessageType
- Optional def: string
Returns Promise<boolean>

datetime

datetime(message: MessageType, date?: DateType, time?: TimeType, format?: string[]): Promise<string>

- Defined in src/helpers/helper.input.ts:94
link

https://github.com/DerekTBrown/inquirer-datepicker-prompt

link

https://www.npmjs.com/package/dateformat

Parameters
- message: MessageType
- Optional date: DateType
- Optional time: TimeType
- Default value format: string[] = ['d', '/', 'm', '/', 'yyyy', ' ', 'HH', ':', 'MM', ':', 'ss']
Returns Promise<string>

expand

expand(msg: MessageType, choices: ChoiceType[] | Array<ChoiceOption>, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:62
Parameters
- msg: MessageType
- choices: ChoiceType[] | Array<ChoiceOption>
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

interact

interact(message: string, type?: string, opts?: Question, def?: string): Promise<string>

- Defined in src/helpers/helper.input.ts:118
Parameters
- message: string
- Default value type: string = "input"
- Default value opts: Question = {}
- Optional def: string
Returns Promise<string>

list

list(msg: MessageType, choices: ChoiceType[] | Array<ChoiceOption>, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:54
Parameters
- msg: MessageType
- choices: ChoiceType[] | Array<ChoiceOption>
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

multiple

multiple(message: MessageType, type: QuestionType, choices: ChoiceType[] | Array<ChoiceOption>, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:99
Parameters
- message: MessageType
- type: QuestionType
- choices: ChoiceType[] | Array<ChoiceOption>
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

onExecuteCommandParse

onExecuteCommandParse(event: CliExecuteCommandParseEvent): void

- Defined in src/helpers/helper.input.ts:35
Parameters
- event: CliExecuteCommandParseEvent
Returns void

password

password(message: MessageType, def?: string, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:70
Parameters
- message: MessageType
- Optional def: string
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

prompt

prompt<T>(question: Question): Promise<T>

- Defined in src/helpers/helper.input.ts:111
Type parameters
- T: any
Parameters
- question: Question
Returns Promise<T>

prompts

prompts(questions: inquirer.Questions): Promise<Answers>

- Defined in src/helpers/helper.input.ts:107
Parameters
- questions: inquirer.Questions
Returns Promise<Answers>

rawlist

rawlist(msg: MessageType, choices: ChoiceType[] | Array<ChoiceOption>, validate?: function): Promise<string>

- Defined in src/helpers/helper.input.ts:58
Parameters
- msg: MessageType
- choices: ChoiceType[] | Array<ChoiceOption>
- Optional validate: function
  - - (answer: any): boolean
    - Parameters
      - answer: any
      Returns boolean
Returns Promise<string>

Generated using TypeDoc