Skip to content

Function: readSecret()

readSecret(promptLabel, options?): Promise<string>

Defined in: packages/aiui-util/src/secret-input.ts:35

Read one secret value: piped/non-interactive stdin reads one line per call (so several keys can arrive as several lines); a real terminal gets a masked prompt (each character echoes as *; Enter submits — an empty line included, which is how callers offer "Enter alone means skip" — backspace edits, Ctrl-C aborts the process with the conventional SIGINT code).

Parameters

promptLabel

string

options?

SecretInputOptions = {}

Returns

Promise<string>