Skip to content

Commit

Permalink
docs(confirm): update outdated docs (#118)
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreDemailly authored Jul 11, 2024
1 parent b70e090 commit 159f79c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,10 @@ Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)
confirm(message: string, options?: ConfirmOptions): Promise<boolean>
```

Boolean prompt, return `options.initial` if user input is different from `y`/`yes`/`n`/`no` (case insensitive), (default `false`).
Boolean prompt, default to `options.initial` (`false`).

> [!TIP]
> You can answer pressing <kbd>Y</kbd> or <kbd>N</kbd>
Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).

Expand Down

0 comments on commit 159f79c

Please sign in to comment.