# node-wget-fetch

> Ultra simple async retrieval of resources or remote files over http or https, an cli tool, and convenience wrapper of node-fetch, and a seamless retry ability

Latest version **1.1.3** (published 2022-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-wget-fetch
pnpm add node-wget-fetch
yarn add node-wget-fetch
bun add node-wget-fetch
```

Provides the commands `wget`, `fetch`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2022-04-22 |
| First published | 2020-11-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12.0.0 |
| Dependencies | 1 |
| Unpacked size | 32.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | l. stubbs |
| Maintainers | technoexpress |
| Keywords | cli, curl, wget, download, file, http, https, fetch, request, promise |

## Links

- npm: https://www.npmjs.com/package/node-wget-fetch
- Repository: https://github.com/techno-express/node-wget-fetch
- Homepage: https://github.com/techno-express/node-wget-fetch#readme
- Issues: https://github.com/techno-express/node-wget-fetch/issues
- npm.io page: https://npm.io/package/node-wget-fetch

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.1.3 (latest) — 2022-04-22
- 1.1.2 — 2022-03-22
- 1.1.0 — 2020-12-08
- 1.0.5 — 2020-11-10
- 1.0.4 — 2020-11-10
- 1.0.3 — 2020-11-09
- 1.0.2 — 2020-11-08
- 1.0.1 — 2020-11-07
- 1.0.0 — 2020-11-02

## README

# node-wget-fetch

[![NPM](https://nodei.co/npm/node-wget-fetch.png)](https://nodei.co/npm/node-wget-fetch/)

[![Dependencies Status][david-image]][david-url] [![Node.js CI](https://github.com/techno-express/node-wget-fetch/workflows/Node.js%20CI/badge.svg)](https://github.com/techno-express/node-wget-fetch/actions) [![codecov](https://codecov.io/gh/techno-express/node-wget-fetch/branch/master/graph/badge.svg?token=QJ7L9IN5Y5)](https://codecov.io/gh/techno-express/node-wget-fetch) [![Maintainability][codeclimate-image]][codeclimate-url][![Release][npm-image]][npm-url]

Ultra simple async retrieval of resources or remote files over http or https, an cli tool, convenience wrapper of [node-fetch](https://www.npmjs.com/package/node-fetch), and a seamless retry ability.

## Install

```bash
npm install node-wget-fetch
```

## Basic API

**fetching**(`url`, *action* = `destination` | `response_body_type` | `options` [, `options`])

- `url` A string representing an absolute url
- `action` Save to **destination** or body action on **response type** or use for **options**

  **response type** can be:
  - '`header`' for all response headers - **raw()**
  - '`object`' for the response object - **no post/pre processing**
  - '`array`' for **arrayBuffer()**
  - '`buffer`' for **buffer()**
  - '`blob`' for **blob()**
  - '`json`' for **json()**
  - '`text`' for **text()**
  - '`stream`' for **NodeJs.readableStream()**

  **default is '`download`'**
- `options` Standard *Request/Fetch* [Options](https://www.npmjs.com/package/node-fetch#fetch-options) for the HTTP(S) request
- Returns: **Promise** of `response body` of above **type**, only if **status text** is `OK`.
- The **response type** will set _Fetch/Request_ **header** `'Content-Type'` as:
  - '`json`' = 'application/json; charset=utf-8'
  - '`text`' = 'application/x-www-form-urlencoded'
  - '`blob`' = 'application/octet'
  - '`buffer`' = 'application/octet'
  - '`header`' = 'text/plain'
  - '`object`' = 'application/json; charset=utf-8'
  - '`stream`' = 'application/octet'
  - '`array`' = 'application/octet'

To customize `retry` *Fetch* operation, update in `options`.

```js
retry:
{
    retries: 1, // The maximum amount of times to retry the operation.
    factor: 2, //The exponential factor to use.
    minTimeout: 1000, // The number of milliseconds before starting the first retry.
    maxTimeout: 'Infinity', // The maximum number of milliseconds between two retries.
    randomize: false, // Randomizes the timeouts by multiplying with a factor between 1 to 2.
 }
```

## Convenience Request Methods

**import { get, head, options } from 'node-wget-fetch';**

**get**(`url`, `response_body_type` [, `options`]);

**head**(`url`, `response_body_type` [, `options`]);

**options**(`url`, `response_body_type` [, `options`);]

### For simply submitting `body` data

> Note: `body` data is passed in, handled by **URLSearchParams** _class_, if `String` or `Object`.

**import { post, put, patch, delete } from 'node-wget-fetch';**

**post**(`url`, `body`, `response_body_type` [, `options`]);

**put**(`url`, `body`, `response_body_type` [, `options`]);

**patch**(`url`, `body`, `response_body_type` [, `options`]);

**delete**(`url`, `body`, `response_body_type` [, `options`]);

## Bring in or access [node-fetch](https://www.npmjs.com/package/node-fetch) directly

**fetching.fetch**(`url` [, `options`]);

## Usage

```javascript
// CommonJS
const fetching = require('node-wget-fetch');
const wget = fetching.wget;

// ESM 12+
import { wget } from 'node-wget-fetch';

wget(url) // retrieve to current directory
    .then((info) => {});
    .catch((error) => {});

wget(url, { headers:  { Accept: '*/*' } }) // with optional `Fetch` options
    .then((info) => {});
    .catch((error) => {});

wget(url, destination_folder_or_filename, { timeout: 2000 } )  // with optional `Fetch` options
    .then((info) => {});
    .catch((error) => {});


fetching(url, responseType, // *responseType* can be:
    // 'header' for all response headers - raw()
    // 'object' for the response object - no post/pre processing
    // 'array' for arrayBuffer()
    // 'buffer' for buffer()
    // 'blob' for blob()
    // 'json' for json()
    // 'text' for text()
    // 'stream' for NodeJs.readableStream()
    // default is 'download'
    { headers: {Accept: '*/*' } }) // with optional `Fetch` options
    )
    .then((processedResponse) => {
        // No file is retrieved or saved,
        // an resolved `Fetch` response body of above type is returned
    });
    .catch((error) => {});
```

## Examples

```javascript
import { wget } from 'node-wget-fetch';

wget('https://raw.github.com/techno-express/node-wget-fetch/master/angleman.png'); // angleman.png saved to current folder

wget('https://raw.github.com/techno-express/node-wget-fetch/master/package.json',
    '/tmp/', // destination path or path with filename, default is ./
    { timeout: 2000 } // Any `Fetch` Options, this sets duration to wait for request in milliseconds, default 0
    )
    .then((info) => {
        console.log('--- headers:'); // display all response headers
        console.log(info.headers);
        console.log('--- file path:'); // display file retrieved info
        console.log(info.filepath);
        console.log('--- file size retrieved:');
        console.log(info.fileSize);
        console.log('--- Do file retrieved match "Content-Length"?:');
        console.log(info.fileSizeMatch);
    })
    .catch((error) => {
        console.log('--- error:');
        console.log(error); // error encountered
    });
);
```

## CLI

Install:

```bash
npm install -g node-wget-fetch
```

Use:

```text
Usage: wget [options] <url>

Or

Usage: fetch [options] <url>

Ultra simple async retrieval of remote files over http or https

Options:

  -h, --help                        output usage information
  -v, --version                     output version number
  -d, --destination <folder>        specify download destination

Usage:

# Download file
$ wget https://github.com/NodeOS/NodeOS/archive/master.zip
$ fetch https://github.com/NodeOS/NodeOS/archive/master.zip

# Download file to location
$ wget https://github.com/NodeOS/NodeOS/archive/master.zip -d path/to/here/
$ fetch https://github.com/NodeOS/NodeOS/archive/master.zip -d path/to/here/
```

## License: MIT

[david-url]: https://david-dm.org/techno-express/node-wget-fetch
[david-image]: http://img.shields.io/david/techno-express/node-wget-fetch.svg
[codeclimate-url]: https://codeclimate.com/github/techno-express/node-wget-fetch/maintainability
[codeclimate-image]: https://api.codeclimate.com/v1/badges/0d6a0bc69a8ea29c7de9/maintainability
[coveralls-url]: https://coveralls.io/github/techno-express/node-wget-fetch
[coveralls-image]: https://coveralls.io/repos/github/techno-express/node-wget-fetch/badge.svg
[npm-url]: https://www.npmjs.org/package/node-wget-fetch
[npm-image]: http://img.shields.io/npm/v/node-wget-fetch.svg

---
_Source: https://npm.io/package/node-wget-fetch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._