Confirm | /prompt/mod.ts | cliffy@v1.0.0-rc.1

Module

x/cliffy/prompt/mod.ts>Confirm

Command line framework for deno 🦕 Including Commandline-Interfaces, Prompts, CLI-Table, Arguments Parser and more...

c4spar/deno-cliffy

Extremely Popular

Go to Latest

assets test

mod.ts (default module)

GenericInputPromptOptions

GenericListKeys

GenericListOption

GenericListOptionGroup

GenericListValueOptions

GlobalPromptMiddleware

CheckboxOptionGroupSettings

CheckboxOptions

CheckboxOptionSettings

CheckboxValueOptions

CheckboxValueSettings

isCheckboxOptionGroup

dim

red

GlobalPromptMiddleware

SelectOptionGroupSettings

class Confirm

extends GenericSuggestions<boolean, string>

import { Confirm } from "https://deno.land/x/cliffy@v1.0.0-rc.1/prompt/mod.ts";

Confirm prompt representation.

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

const confirmed: boolean = await Confirm.prompt("Please confirm");

Constructors

new

Confirm(options: string | ConfirmOptions)

Properties

protected

readonly

settings: ConfirmSettings

Methods

protected

defaults(): string

protected

format(value: boolean): string

Format output value.

protected

getValue(): string

Get input input.

protected

success(value: boolean): string | undefined

protected

transform(value: string): boolean | undefined

Map input value to output value.

protected

validate(value: string): boolean | string

Validate input value.

getDefaultSettings(options: ConfirmOptions): ConfirmSettings

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 | ConfirmOptions): Promise<boolean>

Execute the prompt with provided options.