Skip to content

PasswordPromptConfig ​

Hidden text entry. Whitespace is preserved and defaults are never displayed or accepted.

Signatures ​

ts
interface PasswordPromptConfig extends PromptConfigBase {}

Members ​

Properties ​

empty ​

Empty submission policy. Defaults to retry.

ts
empty?: "accept" | "retry";

kind ​

Request terminal echo suppression; unsupported hosts must reject before reading.

ts
kind: "password";

message ​

The question displayed to the user.

ts
message: string;

sensitive ​

Suppress framework-controlled value hints and diagnostics.

ts
sensitive?: boolean;

validate ​

Validate the unchanged password; invalid answers may be corrected.

ts
validate?: { (value: string): string | true | Promise<string | true>; };

See Also ​

Released under the MIT License.