Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SurveyPromptOptions

Hierarchy

Index

Properties

Methods

Properties

Optional align

align?: "left" | "right"

choices

choices: string[] | BasePromptOptionsWithName[]

Optional delay

delay?: number

Optional edgeLength

edgeLength?: number

Optional footer

footer?: string

Optional header

header?: string

Optional hint

hint?: string

Optional initial

initial?: number | number[]

Optional linebreak

linebreak?: boolean

margin

margin: [number, number, number, number]

Optional maxChoices

maxChoices?: number

message

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

Optional multiple

multiple?: boolean

Optional required

required?: boolean

scale

scale: BasePromptOptionsWithName[]

Optional scroll

scroll?: boolean

Optional separator

separator?: boolean

Optional sort

sort?: boolean

Optional stdin

stdin?: ReadStream

Optional stdout

stdout?: WriteStream

Methods

Optional format

  • format(value: any): any

  • Parameters

    • value: any

    Returns any

Optional onCancel

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

Optional onSubmit

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

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>

Optional validate

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

  • Parameters

    • value: any
    • state: any

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