Function confirm

  • confirm(question, defaultValue?): Promise<boolean>

  • Prompt user for yes/no confirmation with input validation.

    Behavior: Display question with [Y/n] or [y/N] suffix based on default. Accept y/yes/n/no (case insensitive), empty input uses default. Retry loop until valid input received.

    Validation: Rejects invalid input with instruction message. Empty input resolves to defaultValue immediately.

    Parameters

    • question: string

      Confirmation prompt text

    • OptionaldefaultValue: boolean = false

      Value returned for empty input

    Returns Promise<boolean>

    User's boolean choice

    Throws

    Question parameter must be string

    Example

    const deploy = await confirm('Deploy? '); // [y/N]
    const force = await confirm('Force? ', true); // [Y/n]
    if (deploy && !force) console.log('Safe deployment');

Settings

Member Visibility