Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

align?: "left" | "right"
choices: string[] | BasePromptOptionsWithName[]
delay?: number
edgeLength?: number
footer?: string
header?: string
hint?: string
initial?: number | number[]
linebreak?: boolean
margin: [number, number, number, number]
maxChoices?: number
message: string | (() => string) | (() => Promise<string>)
multiple?: boolean
required?: boolean
scroll?: boolean
separator?: boolean
sort?: boolean
stdin?: ReadStream
stdout?: WriteStream

Methods

  • format(value: any): any
  • Parameters

    • value: any

    Returns any

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

    • value: any

    Returns any

  • skip(value: any): boolean | Promise<boolean>
  • Parameters

    • value: any

    Returns boolean | Promise<boolean>

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

    • value: any
    • state: any

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