Function commandSearchPrompt

  • Start a command-line prompt in which the user can search a provided list of CLI commands. Use the : character (configurable) to mean the rest of the input is arguments.

    Parameters

    • data: string[]

      The list to search

    • Optional options: Omit<ISearchPromptOptions, "preRender" | "toKeywords">

      options

    Returns Promise<ICommandSearchPromptResult>

    the user input, its resulting matches, the match selected by the user

    Remarks

    Returns 1 100% matches always from beginning of searched strings/words 2 100% matches anywhere in the searched strings/words

    If the first category can be narrowed down to exactly one result, then it is immediately returned and the other category discarded.

Settings

Member Visibility

Theme

Generated using TypeDoc