Skip to content
Open
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions doc/api/util.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,35 +89,36 @@ callbackFunction((err, ret) => {
});
```

## `util.convertProcessSignalToExitCode(signalCode)`
## `util.convertProcessSignalToExitCode(signal)`

<!-- YAML
added:
- v25.4.0
- v24.14.0
-->

* `signalCode` {string} A signal name (e.g., `'SIGTERM'`, `'SIGKILL'`).
* Returns: {number|null} The exit code, or `null` if the signal is invalid.
* `signal` {string} A signal name (e.g. `'SIGTERM'`)
* Returns: {number} The exit code corresponding to `signal`

The `util.convertProcessSignalToExitCode()` method converts a signal name to its
corresponding POSIX exit code. Following the POSIX standard, the exit code
for a process terminated by a signal is calculated as `128 + signal number`.

If `signal` is not a valid signal name, then an error will be thrown. See
[`signal(7)`][] for a list of valid signals.

```mjs
import { convertProcessSignalToExitCode } from 'node:util';

console.log(convertProcessSignalToExitCode('SIGTERM')); // 143 (128 + 15)
console.log(convertProcessSignalToExitCode('SIGKILL')); // 137 (128 + 9)
console.log(convertProcessSignalToExitCode('INVALID')); // null
```

```cjs
const { convertProcessSignalToExitCode } = require('node:util');

console.log(convertProcessSignalToExitCode('SIGTERM')); // 143 (128 + 15)
console.log(convertProcessSignalToExitCode('SIGKILL')); // 137 (128 + 9)
console.log(convertProcessSignalToExitCode('INVALID')); // null
```

This is particularly useful when working with processes to determine
Expand Down Expand Up @@ -3869,6 +3870,7 @@ npx codemod@latest @nodejs/util-is
[`mime.toString()`]: #mimetostring
[`mimeParams.entries()`]: #mimeparamsentries
[`napi_create_external()`]: n-api.md#napi_create_external
[`signal(7)`]: https://man7.org/linux/man-pages/man7/signal.7.html
[`target` and `handler`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#terminology
[`tty.hasColors()`]: tty.md#writestreamhascolorscount-env
[`util.diff()`]: #utildiffactual-expected
Expand Down
Loading