Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PromptInstance

Hierarchy

Index

Properties

Methods

Properties

Optional footer

footer?: string

Optional header

header?: string

Optional initial

initial?: string | number | boolean | number[] | (() => string) | (() => Promise<string>)

message

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

Optional required

required?: boolean

Optional stdin

stdin?: ReadStream

Optional stdout

stdout?: WriteStream

Methods

cancel

  • cancel(err?: string): void

  • Parameters

    • Optional err: string

    Returns void

Optional format

  • format(value: any): any

  • Parameters

    • value: any

    Returns any

Optional result

  • result(value: any): any

  • Parameters

    • value: any

    Returns any

Optional skip

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

  • Parameters

    • value: any

    Returns boolean | Promise<boolean>

submit

  • submit(): void

  • Returns void

Optional validate

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