Get the preferred Node.js version of a user or project.
const preferredNodeVersion =const version = awaitconsole // 12.10.0// Allowed optionsawait
npm install preferred-node-version
The returned promise resolves to an object with the following properties. An empty object is returned if no preferred Node.js version was found.
If a file cannot be read or if it contains an invalid version, the promise is rejected with an error.
Full Node.js version. For example
Node.js version as specified in the Node.js version file. This might include
aliases or version ranges. For example
Absolute path to the Node.js version file. Either
Name of the environment variable containing the version. For example
envVariable is defined.
Start looking for a Node.js version file from this directory.
true, find the global Node.js version instead:
- use only the home directory and environment variables
- ignore the current directory and parent directories
Base URL to fetch the list of available Node.js versions. Can be customized (for
The following environment variables can also be used:
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 used
false: the cache will be used even if it's older than one hour
nve: Run a specific Node.js version (CLI)
nvexeca: Run a specific Node.js version (programmatic)
get-node: Download Node.js
normalize-node-version: Normalize and validate Node.js versions
node-version-alias: Resolve Node.js version aliases like
all-node-versions: List all available Node.js versions
fetch-node-website: Fetch releases on nodejs.org
If you found a bug or would like a new feature, don't hesitate to submit an issue on GitHub.
For other questions, feel free to chat with us on Gitter.
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
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!
Thanks go to our wonderful contributors:
💻 🎨 🤔 📖
💻 ⚠️ 🤔