Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

initial?: any
message: string | (() => string) | (() => Promise<string>)
name: string | (() => string)
required?: boolean
skip?: boolean | ((state: object) => boolean | Promise<boolean>)
stdin?: ReadStream
stdout?: WriteStream
type: string | (() => string)

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>
  • Parameters

    Returns boolean | Promise<boolean>

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

    Returns boolean | Promise<boolean>

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

    • value: string

    Returns string | Promise<string>

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

    • value: string

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