diff --git a/index.d.ts b/index.d.ts index d0935bee7b..af8af68431 100644 --- a/index.d.ts +++ b/index.d.ts @@ -41,6 +41,8 @@ declare namespace execa { /** Path to the Node.js executable to use in child processes. + For example this can be used together with `get-node` to run a specific Node.js version in a child process. + This can be either an absolute path or a path relative to the `cwd` option. Requires `preferLocal` to be `true`. diff --git a/readme.md b/readme.md index a94b1cef18..f30cc31ae7 100644 --- a/readme.md +++ b/readme.md @@ -315,6 +315,8 @@ Default: `process.execPath` (current Node.js executable) Path to the Node.js executable to use in child processes. +For example this can be used together with [`get-node`](https://github.com/ehmicky/get-node) to run a specific Node.js version in a child process. + This can be either an absolute path or a path relative to the [`cwd` option](#cwd). Requires [`preferLocal`](#preferlocal) to be `true`.