Skip to content package
preferred-node-version v5.0.1 Get the preferred Node.js version of a project or user
node >=18.18.0 4 deps esm types open source
overview readme
license Apache-2.0
deps 4
unpacked 30.9 kB
files 14
node >=18.18.0 $ npm install preferred-node-version@5.0.1n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
node nodejs nvm npx versions versioning exec shell terminal command-line cli dependency-management
install size Estimated unpacked size across 15 packages.
314.9 kB
Includes dependencies.
dependencies 4 direct · 1 outdated
versions Latest published Mar 29, 2025
Jul 13, 2023
maintainers Registry package owners.
Get the preferred Node.js version of a user or project.
This looks for (from highest to lowest priority):
nvm aliases (like current or lts/erbium) and version ranges (like 12 or
>=12) are resolved to regular "major.minor.patch" version strings.
Examples import preferredNodeVersion from 'preferred-node-version'
// Look for any `.nvmrc` or `package.json` (`engines.node` field)
const { version } = await preferredNodeVersion ()
console. log (version) // 12.10.0 copy // Search only the home directory and environment variables
await preferredNodeVersion ({ global: true }) copy // Start looking for a Node.js version file from this directory instead
await preferredNodeVersion ({ cwd: '/path/to/cwd' }) copy // Search for specific files
await preferredNodeVersion ({
files: [ '/path/to/.nvmrc' , '/path/to/package.json' ],
}) copy
Install npm install preferred-node-version copy This package works in Node.js >=18.18.0.
Usage
preferredNodeVersion(options?) options: object?
Returns : Promise<object>
Return value 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.
version Full Node.js version. For example 12.16.2
rawVersion Node.js version as specified in the Node.js version file. This might include
aliases or version ranges. For example latest, lts/erbium, 12 or
12.16.2.
filePath Absolute path to the Node.js version file. Either filePath or envVariable is
defined.
envVariable Name of the environment variable containing the version. For example
NODE_VERSION. Either filePath or envVariable is defined.
options
cwd Type : string | URL
Default : process.cwd()
Start looking for a Node.js version file from this directory.
global Type : boolean
Default : false
If true, find the global Node.js version instead:
use only the home directory and environment variables
ignore the current directory and parent directories
files Type : string[]
Default : []
Additional files to lookup. Their filenames must be one of package.json,
.nvmrc, etc.
mirror Type : string
Default : https://nodejs.org/dist
Base URL to fetch the list of available Node.js versions. Can be customized (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
Default : undefined
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
signal Cancels when the signal is aborted.
NODE_VERSION_FILES List of filenames being searched: .nvmrc, package.json, etc.
See also
Support Everyone is welcome regardless of personal background. We enforce a
Code of conduct in order to promote a positive and
inclusive environment.
Contributing 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!
Thanks go to our wonderful contributors: