Class SelectionBuilder

defaultOption

options

prompt

addDefaultOption

• addDefaultOption(index): SelectionBuilder

• Parameters

  • index: number

  Returns SelectionBuilder

addOption

• addOption(option): SelectionBuilder

• Parameters

  • option: Option | {
        option: string;
        value: any;
    }

  Returns SelectionBuilder

addOptions

• addOptions(options): SelectionBuilder

• Parameters

  • options: (Option | {
        option: string;
        value: any;
    })[]

  Returns SelectionBuilder

build

• build(): Promise<Option[]>

• Returns Promise<Option[]>

createScrollableOptionString

• createScrollableOptionString(currentSelection, selected): string

• Parameters

  • currentSelection: number

  • selected: Set<number>

  Returns string

getPromptString

• getPromptString(currentSelection, selectedOptions): string

• Returns the string to print to the console. Includes the prompt, options, and instructions.

  Returns

  The string to print to the console

  Parameters

  • currentSelection: number

    The index of the currently selected option (The option the cursor is on)

  • selectedOptions: Set<number>

    The indexes of the options that are currently selected and will be returned

  Returns string

removeDefaultOption

• removeDefaultOption(index): SelectionBuilder

• Parameters

  • index: number

  Returns SelectionBuilder

setPrompt

• setPrompt(prompt): SelectionBuilder

• Parameters

  • prompt: string

  Returns SelectionBuilder

Static new

• new(): SelectionBuilder

• Returns SelectionBuilder