fetch-node-website
Version:
Fetch releases on nodejs.org
120 lines (84 loc) • 4.37 kB
Markdown
[](https://www.npmjs.com/package/fetch-node-website)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/fetch-node-website)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Fetch releases on nodejs.org
Download release files available on
[`https://nodejs.org/dist/`](https://nodejs.org/dist/).
# Example
```js
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
```bash
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](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
## 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`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
Cancels the release download 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`
- [`normalize-node-version`](https://github.com/ehmicky/normalize-node-version):
Normalize and validate Node.js versions
- [`all-node-versions`](https://github.com/ehmicky/all-node-versions): List all
available Node.js versions
# 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: -->
<!-- ALL-CONTRIBUTORS-LIST:START -->
<!-- prettier-ignore -->
<!--
<table><tr><td align="center"><a href="https://fosstodon.org/@ehmicky"><img src="https://avatars2.githubusercontent.com/u/8136211?v=4" width="100px;" alt="ehmicky"/><br /><sub><b>ehmicky</b></sub></a><br /><a href="https://github.com/ehmicky/fetch-node-website/commits?author=ehmicky" title="Code">💻</a> <a href="#design-ehmicky" title="Design">🎨</a> <a href="#ideas-ehmicky" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ehmicky/fetch-node-website/commits?author=ehmicky" title="Documentation">📖</a></td></tr></table>
-->
<!-- ALL-CONTRIBUTORS-LIST:END -->