Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rework exitOverride description #2098

Merged
merged 4 commits into from
Dec 12, 2023
Merged

Rework exitOverride description #2098

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4b7ad10
Rework exitOverride description
shadowspawn Dec 9, 2023
360adb8
Fix description to match implementation
shadowspawn Dec 9, 2023
4fbf634
Tweak wording again
shadowspawn Dec 9, 2023
91722f6
Take out the first in case people think it is before displaying helpe…
shadowspawn Dec 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,8 +1094,9 @@ program.error('Custom processing has failed', { exitCode: 2, code: 'my.custom.er
By default, Commander calls `process.exit` when it detects errors, or after displaying the help or version. You can override
this behaviour and optionally supply a callback. The default override throws a `CommanderError`.

The override callback is passed a `CommanderError` with properties `exitCode` number, `code` string, and `message`. The default override behaviour is to throw the error, except for async handling of executable subcommand completion which carries on. The normal display of error messages or version or help
is not affected by the override which is called after the display.
The override callback is passed a `CommanderError` with properties `exitCode` number, `code` string, and `message`.
Commander expects the callback to terminate the normal program flow, and will call `process.exit` if the callback returns.
The normal display of error messages or version or help is not affected by the override which is called after the display.

```js
program.exitOverride();
Expand Down
Loading