diff --git a/index.d.ts b/index.d.ts index 0f0dd668bc..6a7e21ef10 100644 --- a/index.d.ts +++ b/index.d.ts @@ -436,7 +436,7 @@ declare const execa: { /** Execute a Node.js script as a child process. - Same as `execa('node', [file, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)): + Same as `execa('node', [scriptPath, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)): - the current Node version and options are used. This can be overridden using the `nodePath` and `nodeArguments` options. - the `shell` option cannot be used - an extra channel [`ipc`](https://nodejs.org/api/child_process.html#child_process_options_stdio) is passed to [`stdio`](#stdio) @@ -451,12 +451,12 @@ declare const execa: { options?: execa.NodeOptions ): execa.ExecaChildProcess; node( - file: string, + scriptPath: string, arguments?: readonly string[], options?: execa.Options ): execa.ExecaChildProcess; - node(file: string, options?: execa.Options): execa.ExecaChildProcess; - node(file: string, options?: execa.Options): execa.ExecaChildProcess; + node(scriptPath: string, options?: execa.Options): execa.ExecaChildProcess; + node(scriptPath: string, options?: execa.Options): execa.ExecaChildProcess; }; export = execa; diff --git a/readme.md b/readme.md index 92fb5d318a..100cd3666a 100644 --- a/readme.md +++ b/readme.md @@ -188,7 +188,7 @@ Returns or throws a [`childProcessResult`](#childProcessResult). Execute a Node.js script as a child process. -Same as `execa('node', [file, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)): +Same as `execa('node', [scriptPath, ...arguments], options)` except (like [`child_process#fork()`](https://nodejs.org/api/child_process.html#child_process_child_process_fork_modulepath_args_options)): - the current Node version and options are used. This can be overridden using the [`nodePath`](#nodepath-for-node-only) and [`nodeArguments`](#nodearguments-for-node-only) options. - the [`shell`](#shell) option cannot be used - an extra channel [`ipc`](https://nodejs.org/api/child_process.html#child_process_options_stdio) is passed to [`stdio`](#stdio)