Class Enquirer<T>

Type parameters

T = object

Hierarchy

EventEmitter
- Enquirer

Index

Constructors

constructor

Methods

Constructors

constructor

new Enquirer<T>(options?: object, answers?: T): Enquirer<T>

Overrides EventEmitter.constructor
- Defined in node_modules/enquirer/index.d.ts:104
Type parameters
- T = object
Parameters
- Optional options: object
- Optional answers: T
Returns Enquirer<T>

Methods

prompt

prompt(questions: PromptOptions | ((this: Enquirer<object>) => PromptOptions) | (PromptOptions | ((this: Enquirer<object>) => PromptOptions))[]): Promise<T>

- Defined in node_modules/enquirer/index.d.ts:125
Prompt function that takes a "question" object or array of question objects, and returns an object with responses from the user.

Parameters
- questions: PromptOptions | ((this: Enquirer<object>) => PromptOptions) | (PromptOptions | ((this: Enquirer<object>) => PromptOptions))[]
  
  Options objects for one or more prompts to run.
Returns Promise<T>

register

register(type: string, fn: typeof BasePrompt | (() => typeof BasePrompt)): Enquirer<T>
register(type: {}): Enquirer<T>

- Defined in node_modules/enquirer/index.d.ts:112
Register a custom prompt type.

Parameters
- type: string
- fn: typeof BasePrompt | (() => typeof BasePrompt)
  
  Prompt class, or a function that returns a Prompt class.
Returns Enquirer<T>
- Defined in node_modules/enquirer/index.d.ts:117
Register a custom prompt type.

Parameters
- type: {}
  - [key: string]: typeof BasePrompt | (() => typeof BasePrompt)
Returns Enquirer<T>

use

use(plugin: (this: Enquirer<T>, enquirer: Enquirer<T>) => void): Enquirer<T>

- Defined in node_modules/enquirer/index.d.ts:137
Use an enquirer plugin.

Parameters
- plugin: (this: Enquirer<T>, enquirer: Enquirer<T>) => void
  
  Plugin function that takes an instance of Enquirer.
  - - (this: Enquirer<T>, enquirer: Enquirer<T>): void
    - Parameters
      - this: Enquirer<T>
      - enquirer: Enquirer<T>
      Returns void
Returns Enquirer<T>