Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BooleanPromptOptions

Hierarchy

Index

Properties

Methods

Properties

Optional initial

initial?: boolean

message

message: string | (() => string) | (() => Promise<string>)

name

name: string | (() => string)

Optional required

required?: boolean

Optional skip

skip?: boolean | ((state: object) => boolean | Promise<boolean>)

Optional stdin

stdin?: ReadStream

Optional stdout

stdout?: WriteStream

type

type: "confirm"

Methods

Optional format

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

  • Parameters

    • value: string

    Returns string | Promise<string>

Optional onCancel

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

Optional onSubmit

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

Optional result

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

  • Parameters

    • value: string

    Returns string | Promise<string>

Optional validate

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

  • Parameters

    • value: string

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