Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

align?: "left" | "right"
choices: string[] | Choice[]
delay?: number
edgeLength?: number
initial?: number
linebreak?: boolean
maxChoices?: number
message: string | (() => string) | (() => Promise<string>)
muliple?: boolean
name: string | (() => string)
required?: boolean
scroll?: boolean
separator?: boolean
skip?: boolean | ((state: object) => boolean | Promise<boolean>)
sort?: boolean
stdin?: ReadStream
stdout?: WriteStream
type: "autocomplete" | "editable" | "form" | "multiselect" | "select" | "survey" | "list" | "scale"

Methods

  • format(value: string): string | Promise<string>
  • Parameters

    • value: string

    Returns string | Promise<string>

  • onCancel(name: string, value: any, prompt: Enquirer.Prompt): boolean | Promise<boolean>
  • onSubmit(name: string, value: any, prompt: Enquirer.Prompt): boolean | Promise<boolean>
  • result(value: string): string | Promise<string>
  • Parameters

    • value: string

    Returns string | Promise<string>

  • validate(value: string): string | boolean | Promise<string> | Promise<boolean>
  • Parameters

    • value: string

    Returns string | boolean | Promise<string> | Promise<boolean>