Module

x/cliffy/prompt/mod.ts>GenericPrompt

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...
c4spar/deno-cliffy
Extremely Popular
Go to Latest
class GenericPrompt
Abstract
import { GenericPrompt } from "https://dotland.deno.dev/x/cliffy@v0.15.0/prompt/mod.ts";

Constructors

new
protected
GenericPrompt(settings: S)

Properties

protected
isRunning: boolean
protected
lastError: string | undefined
protected
screen
protected
value: T | undefined

Methods

protected
clear()
protected
error(message: string)
protected
execute(): Promise<T>
protected
abstract
format(value: T): string
protected
getMessage(): string | Promise<string>
protected
getSuccessMessage(value: T)
protected
abstract
getValue(): V
protected
abstract
handleEvent(event: KeyEvent): Promise<boolean>
protected
hint(hint: string)
protected
isKey<K extends any, N extends keyof K>(
keys: K | undefined,
name: N,
event: KeyEvent,
): boolean
protected
message(message: string)
protected
preBufferEmptyLines(message: string)
protected
read(): Promise<boolean>
protected
readChar(): Promise<Uint8Array>
protected
readKey(): Promise<KeyEvent[]>
protected
abstract
setPrompt(message: string): void | Promise<void>
protected
abstract
transform(value: V): T | undefined
protected
transformValue(value: V): T | undefined
protected
abstract
validate(value: V): ValidateResult
protected
validateValue(value: V): Promise<boolean>
protected
write(value: string)
protected
writeLine(value?: string)
prompt(): Promise<T>

Static Properties

protected
injectedValue: any | undefined

Static Methods

inject(value: any): void
import GenericPrompt
import { GenericPrompt } from "https://dotland.deno.dev/x/cliffy@v0.15.0/prompt/mod.ts";