Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/normalize-node-version
Normalize and validate Node.js versions
https://github.com/ehmicky/normalize-node-version
bash cli command-line dependency-management es6 exec javascript library node nodejs npmjs npx nvm operating-system package-manager shell terminal typescript versioning versions
Last synced: 3 months ago
JSON representation
Normalize and validate Node.js versions
- Host: GitHub
- URL: https://github.com/ehmicky/normalize-node-version
- Owner: ehmicky
- License: apache-2.0
- Created: 2019-08-08T13:11:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:57.000Z (4 months ago)
- Last Synced: 2024-09-28T15:21:07.926Z (4 months ago)
- Topics: bash, cli, command-line, dependency-management, es6, exec, javascript, library, node, nodejs, npmjs, npx, nvm, operating-system, package-manager, shell, terminal, typescript, versioning, versions
- Language: JavaScript
- Homepage:
- Size: 10.3 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/normalize-node-version)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/normalize-node-version)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
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](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Example
```js
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
```bash
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](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# Usage
## normalizeNodeVersion(versionRange, options?)
`versionRange`: `string`\
`options`: `object?`\
_Returns_: `Promise`
### 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 used
- `false`: the cache will be used even if it's older than one hour
#### signal
_Type_:
[`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
Cancels when the signal is aborted.
# See also
- [`nve`](https://github.com/ehmicky/nve): Run a specific Node.js version (CLI)
- [`nvexeca`](https://github.com/ehmicky/nve): Run a specific Node.js version
(programmatic)
- [`get-node`](https://github.com/ehmicky/get-node): Download Node.js
- [`preferred-node-version`](https://github.com/ehmicky/preferred-node-version):
Get the preferred Node.js version of a project or user
- [`node-version-alias`](https://github.com/ehmicky/node-version-alias): Resolve
Node.js version aliases like `latest`, `lts` or `erbium`
- [`all-node-versions`](https://github.com/ehmicky/all-node-versions): List all
available Node.js versions
- [`fetch-node-website`](https://github.com/ehmicky/fetch-node-website): Fetch
releases on nodejs.org
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) 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](CONTRIBUTING.md). Pull requests are welcome!
Thanks go to our wonderful contributors:
