← Back to index
function prompt

Shows the given message and waits for the user's input. Returns the user's input as string.

If the default value is given and the user inputs the empty string, then it returns the given default value.

If the default value is not given and the user inputs the empty string, it returns null.

If the stdin is not interactive, it returns null.

Parameters

🔗
message: string
🔗
defaultValue: string

Return Type

🔗
string | null