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

x/cliffy/prompt/mod.ts>Input

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

Input prompt representation.

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

const confirmed: string = await Input.prompt("Enter your name");

Constructors

new
Input(options: string | InputOptions)

Properties

protected
readonly
settings: InputSettings

Methods

protected
format(value: string): string

Format output value.

protected
getValue(): string

Get input value.

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

Map input value to output value.

protected
validate(value: string): boolean | string

Validate input value.

getDefaultSettings(options: InputOptions): InputSettings

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 | InputOptions): Promise<string>

Execute the prompt with provided options.