Skip to main content
Module

x/cliffy/prompt/secret.ts>Secret

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

Secret prompt representation.

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

const password: string = await Secret.prompt("Enter your password");

Constructors

new
Secret(options: string | SecretOptions)

Properties

protected
readonly
settings: SecretSettings

Methods

protected
format(value: string): string

Format output value.

protected
getValue(): string

Get input input.

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

Read user input.

protected
transform(value: string): string | undefined

Map input value to output value.

protected
validate(value: string): boolean | string

Validate input value.

getDefaultSettings(options: SecretOptions): SecretSettings

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

Execute the prompt with provided message or options.