nvm + execa = nvexeca
npm install nvexeca





nvm + execa = nvexeca.
Execa improves
child processes execution with a
promise interface, cross-platform support, local binaries, interleaved output,
and more.
nvexeca is a thin wrapper around Execa to run any file or command using any
Node.js version.
Unlike nvm exec
it:
- is run programmatically
- does not need a separate installation step for each Node version
- can run the major release's latest minor/patch version automatically
- does not require Bash
- is installed as a Node module
- works on Windows. No need to run as Administrator.
nvexeca executes a single file or command. It does not change the node
nor npm global binaries. To run a specific Node.js version for an **entire
project or shell session**, please use nvm,nvm-windows,n or nvs
instead.
``js
import nvexeca from 'nvexeca'
const { childProcess, versionRange, version } = await nvexeca('8', 'node', [
'--version',
])
console.log(Node ${versionRange} (${version})) // Node 8 (8.16.2)Exit code: ${exitCode}
const { exitCode, stdout, stderr } = await childProcess
console.log() // 0`
console.log(stdout) // v8.16.2
`bash`
npm install nvexeca
node >=18.18.0 must be installed. However the command run by nvexeca can use
any Node version (providing it is compatible with it).
This package is an ES module and must be loaded using
an import or import() statement,
not require(). If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.
To use this as a CLI instead, please check
nve.
Executes command ...args with a specific Node.js versionRange.
#### versionRange
_Type_: string
This can be:
- any version range such as 12, 12.6.0<12
or latest
- : Latest available Node versionlts
- : Latest LTS Node versionglobal
- : Global Node version.nvmrc
- Using the home directory orpackage.json
(engines.node field)local
- Some similar files
used by other Node.js version managers are also searched for
- If nothing is found, defaults to the current process's Node version
- : Current directory's Node version.nvmrc
- Using the current directory or parent directories
,package.json
(engines.node field)global
or
similar files
- Defaults to the version.nvmrc
- a file path towards a ,package.json
(engines.node field)
or
similar files
#### command
_Type_: string
File or command to execute. Both global and local binaries can be executed.
Must be compatible with the specific Node versionRange. For example npm is>=6
only compatible with Node .
#### args
_Type_: string[]?
Arguments to pass to the command.
_Type_: object?
All Execa options are available. Please refer to Execa for the list of
possible options.
The
preferLocal option
is always true.
The following options are also available.
#### dry
_Type_: boolean\false
_Default_:
Do not execute the command. This can be used to cache the initial Node.js binary
download.
#### progress
_Type_: boolean\false
_Default_:
Whether to show a progress bar when the Node binary is downloading.
#### mirror
_Type_: string\https://nodejs.org/dist
_Default_:
Base URL to retrieve Node binaries. Can be overridden (for example
https://npmmirror.com/mirrors/node).
The following environment variables can also be used: NODE_MIRROR,NVM_NODEJS_ORG_MIRROR, N_NODE_MIRROR or NODIST_NODE_MIRROR.
#### fetch
_Type_: boolean\undefined
_Default_:
The list of available Node.js versions is cached for one hour by default. If the
fetch option is:
- true: the cache will not be usedfalse
- : the cache will be used even if it's older than one hour
#### arch
_Type_: string\process.arch
_Default_:
Node.js binary's CPU architecture. This is useful for example when you're on x64
but would like to run Node.js x32.
All the values from
process.arch are
allowed except mips and mipsel.
#### cwd
_Type_: string | URL\process.cwd()
_Default_:
Current working directory of the child process.
When using the local alias, this
also starts looking for a Node.js version file from this directory.
_Type_: Promise
Promise resolved after the Node.js version has been cached locally (if it has
not been cached yet).
If you want to wait for the command to complete as well, you should awaitchildProcess
the returned .
`js`
const { childProcess } = await nvexeca('8', 'node', ['--version'])
const { exitCode, stdout, stderr } = await childProcess
#### childProcess
_Type_:
ResultPromise?
childProcess instance.
It is also a Promise resolving or rejecting with aResult.Promise
The should be awaited if you want to wait for the process to complete.
This is undefined when the dry option is true.
#### versionRange
_Type_: string
Node.js version passed as input, such as "v10".
#### version
_Type_: string
Normalized Node.js version. For example if "v10" was passed as input,version will be "10.17.0".
#### command
_Type_: string
File or command that was executed.
#### args
_Type_: string[]
Arguments that were passed to the command.
#### execaOptions
_Type_: object
Options
that were passed to Execa.
The first time nvexeca is run with a new VERSION, the Node binary is
downloaded under the hood. This initially takes few seconds. However subsequent
runs are almost instantaneous.
If your code is using native modules, nvexeca works providing:
- they are built with N-API
- the target Node.js version is >=8.12.0 (since N-API was not available or
stable before that)
Otherwise the following error message is shown:
Error: The module was compiled against a different Node.js version.
- nve: nvexeca as a CLIexeca
- : Process execution for humansget-node
- : Download Node.jspreferred-node-version
- :node-version-alias
Get the preferred Node.js version of a project or user
- : Resolvelatest
Node.js version aliases like , lts or erbiumnormalize-node-version
- :all-node-versions
Normalize and validate Node.js versions
- : List allfetch-node-website
available Node.js versions
- : Fetchglobal-cache-dir
releases on nodejs.org
- : Get the
global cache directory
For any question, _don't hesitate_ to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a
Code of conduct in order to promote a positive and
inclusive environment.
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
guidelines. Pull requests are welcome!
ehmicky 💻 🎨 🤔 📖 | Nicolas Goudry 📖 | Pedro Augusto de Paula Barbosa 💬 |