Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/cliffy/prompt/mod.ts>List

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Go to Latest
class List
extends GenericSuggestions<string[], string>
import { List } from "https://deno.land/x/cliffy@v1.0.0-rc.1/prompt/mod.ts";

List prompt representation.

import { List } from "./mod.ts";

const confirmed: Array<string> = await List.prompt("Enter some keywords");

Constructors

new
List(options: string | ListOptions)

Properties

protected
readonly
settings: ListSettings

Methods

protected
addChar(char: string): void

Add char.

protected
complete(): Promise<string>
protected
deleteChar(): void

Delete char left.

protected
format(value: string[]): string

Format output value.

protected
getCurrentInputValue(): string
protected
getTags(value?: string): Array<string>
protected
getValue(): string

Get input value.

protected
input(): string
protected
regexp(): RegExp

Create list regex.

protected
success(value: string[]): string | undefined
protected
transform(value: string): string[]

Map input value to output value.

protected
validate(value: string): boolean | string

Validate input value.

getDefaultSettings(options: ListOptions): ListSettings

Static Methods

inject(value: string): void

Inject prompt value. If called, the prompt doesn't prompt for an input and returns immediately the injected value. Can be used for unit tests or pre selections.

prompt(options: string | ListOptions): Promise<string[]>

Execute the prompt with provided options.