normalize-node-version
v14.0.0
Published
Normalize and validate Node.js versions
Downloads
521,436
Maintainers
Readme
Normalize and validate Node.js versions.
Takes any version range as inputs such as 8
, 8.5.0
or >=8
and returns a
"major.minor.patch"
string. Throws if the Node.js version does not exist.
Hire me
Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.
Example
import normalizeNodeVersion from 'normalize-node-version'
await normalizeNodeVersion('8') // '8.17.0'
await normalizeNodeVersion('8.5.0') // '8.5.0'
await normalizeNodeVersion('v8.5.0') // '8.5.0'
await normalizeNodeVersion('<7') // '6.17.1'
await normalizeNodeVersion('8.5.2') // Error: Invalid Node version
await normalizeNodeVersion('not_a_version') // Error: Invalid Node version
// All available options
await normalizeNodeVersion('8', {
// Use a mirror for Node.js binaries
mirror: 'https://npmmirror.com/mirrors/node',
// Do not cache the list of available Node.js versions
fetch: true,
// Cancels when the signal is aborted
signal: new AbortController().signal,
})
Install
npm install normalize-node-version
This package works in Node.js >=18.18.0.
This is an ES module. It 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.
Usage
normalizeNodeVersion(versionRange, options?)
versionRange
: string
options
: object?
Returns: Promise<string>
options
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 usedfalse
: the cache will be used even if it's older than one hour
signal
Type:
AbortSignal
Cancels when the signal is aborted.
See also
nve
: Run a specific Node.js version (CLI)nvexeca
: Run a specific Node.js version (programmatic)get-node
: Download Node.jspreferred-node-version
: Get the preferred Node.js version of a project or usernode-version-alias
: Resolve Node.js version aliases likelatest
,lts
orerbium
all-node-versions
: List all available Node.js versionsfetch-node-website
: Fetch releases on nodejs.org
Support
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.
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: