Skip to content

ehmicky/fetch-node-website

Repository files navigation

Node TypeScript Codecov Mastodon Medium

Fetch releases on nodejs.org

Download release files available on https://nodejs.org/dist/.

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 fetchNodeWebsite from 'fetch-node-website'

const stream = await fetchNodeWebsite('v12.8.0/node-v12.8.0-linux-x64.tar.gz')

// Example with options
const otherStream = await fetchNodeWebsite(
  'v12.8.0/node-v12.8.0-linux-x64.tar.gz',
  {
    progress: true,
    mirror: 'https://npmmirror.com/mirrors/node',
    signal: new AbortController().signal,
  },
)

Install

npm install fetch-node-website

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

fetchNodeWebsite(path, options?)

path: string
options: object
Returns: Promise<Stream>

options

progress

Type: boolean
Default: false

Show a progress bar.

mirror

Type: string
Default: https://nodejs.org/dist

Base URL. 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.

signal

Type: AbortSignal

Cancels the release download when the signal is aborted.

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!