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

x/cliffy/prompt/mod.ts>Toggle

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

Toggle prompt representation.

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

const password: boolean = await Toggle.prompt("Please confirm");

Constructors

new
Toggle(options: string | ToggleOptions)

Properties

protected
readonly
settings: ToggleSettings
protected
status: string

Methods

protected
format(value: boolean): string

Format output value.

protected
getValue(): string

Get input value.

protected
handleEvent(event: KeyCode): Promise<void>

Handle user input event.

protected
message(): string
protected
read(): Promise<boolean>

Read user input from stdin, handle events and validate user input.

protected
selectActive()

Set active.

protected
selectInactive()

Set inactive.

protected
transform(value: string): boolean | undefined

Map input value to output value.

protected
validate(value: string): boolean | string

Validate input value.

getDefaultSettings(options: ToggleOptions): ToggleSettings

Static Methods

prompt(options: string | ToggleOptions): Promise<boolean>

Execute the prompt.