Miss any of our Open RFC calls?Watch the recordings here! »

preferred-node-version

1.1.0 • Public • Published

Codecov Build Node Gitter Twitter Medium

Get the preferred Node.js version of a user or project.

This looks for any .nvmrc or package.json (engines.node field) in the current directory, parent directories or home directory.

This also looks for any .node-version, .n-node-version, .naverc, .nodeenvrc file or NODE_VERSION, NODIST_NODE_VERSION environment variable.

Example

const preferredNodeVersion = require('preferred-node-version')
 
const { version } = await preferredNodeVersion()
console.log(version) // 12.10.0
 
// Allowed options
await preferredNodeVersion({
  // Start looking for a Node.js version file from this directory
  cwd: '/path/to/cwd',
  // Use a mirror for Node.js binaries
  mirror: 'https://npm.taobao.org/mirrors/node',
  // Do not cache the list of available Node.js versions
  fetch: true,
})

Install

npm install preferred-node-version

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

Type: string

Full Node.js version. For example 12.16.2

rawVersion

Type: string

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

Type: string?

Absolute path to the Node.js version file. Either filePath or envVariable is defined.

envVariable

Type: string?

Name of the environment variable containing the version. For example NODE_VERSION. Either filePath or envVariable is defined.

options

cwd

Type: string
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

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://npm.taobao.org/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

See also

Support

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.

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:


ehmicky

💻 🎨 🤔 📖

Adrien Becchis

💻 ⚠️ 🤔

Install

npm i preferred-node-version

DownloadsWeekly Downloads

189

Version

1.1.0

License

Apache-2.0

Unpacked Size

46.1 kB

Total Files

24

Homepage

git.io/JvjBb

Last publish

Collaborators

  • avatar