Skip to main content
prompt - Platform - Web documentation
function prompt
prompt(
message?: string,
defaultValue?: string,
): string | null

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 the empty string.

If the stdin is not interactive, it returns null.

Parameters

optional
message: string
optional
defaultValue: string

Return Type

string | null
Back to top