enquirer

• Version 2.4.1
• Published 11 months ago
• 189 kB
• 2 dependencies
• MIT license

Install

npm i enquirer

yarn add enquirer

pnpm add enquirer

Overview

Stylish, intuitive and user-friendly prompt system. Fast and lightweight enough for small projects, powerful and extensible enough for the most advanced use cases.

Index

Functions

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

Classes

class Enquirer<T = object> extends EventEmitter {}

constructor(options?: {}, answers?: {});

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

register: {
    (type: string, fn: typeof BasePrompt | (() => typeof BasePrompt)): this;
    (type: {
        [key: string]: typeof BasePrompt | (() => typeof BasePrompt);
    }): this;
};

use: (plugin: (this: this, enquirer: this) => void) => this;

class Prompt extends BasePrompt {}

Package Files (1)

• index.d.ts

Dependencies (2)

• ansi-colors
• strip-ansi

Dev Dependencies (8)

• @types/node
• gulp-format-md
• inquirer
• mocha
• nyc
• prompts
• time-require
• typescript

Peer Dependencies (0)

No peer dependencies.

• Updated 11 months ago.
  Package analyzed in 2569 ms.
• Missing or incorrect documentation? Open an issue for this package.
• Back to top