node-version-alias

    2.0.0 • Public • Published

    Codecov Build Node Twitter Medium

    Resolve Node.js version aliases like latest, lts or erbium.

    Those aliases are used by Node.js version managers like nvm, nvs, n, nave, nodeenv or nodist.

    This resolves them to a "major.minor.patch" version string. The following aliases are supported:

    Normal version ranges (like 12.1.0, 12 or >=10) are valid inputs too.

    Examples

    import nodeVersionAlias from 'node-version-alias'
    
    // Note: the following examples might be out-of-sync with the actual versions
    console.log(await nodeVersionAlias('latest')) // 13.13.0
    console.log(await nodeVersionAlias('lts')) // 12.16.2
    console.log(await nodeVersionAlias('lts/erbium')) // 12.16.2
    console.log(await nodeVersionAlias('erbium')) // 12.16.2
    console.log(await nodeVersionAlias('lts/-2')) // 10.20.1
    
    // Normal version ranges
    console.log(await nodeVersionAlias('10.0.0')) // 10.0.0
    console.log(await nodeVersionAlias('10')) // 10.20.1
    console.log(await nodeVersionAlias('^10')) // 10.20.1
    console.log(await nodeVersionAlias('>=10')) // 13.13.0
    
    // Allowed options
    await nodeVersionAlias('latest', {
      // 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 node-version-alias

    This package is an ES module and must be loaded using an import or import() statement, not require().

    Usage

    nodeVersionAlias(alias, options?)

    alias: string
    options: object?
    Returns: Promise<string>

    The return value resolves to a "major.minor.patch" version 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://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

    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:


    ehmicky

    💻 🎨 🤔 📖

    Adrien Becchis

    💻 ⚠️ 🤔

    Install

    npm i node-version-alias

    Homepage

    git.io/JfJN3

    DownloadsWeekly Downloads

    34,116

    Version

    2.0.0

    License

    Apache-2.0

    Unpacked Size

    36.5 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar