# request-download-info

> A module to show info about request

Latest version **1.0.2** (published 2018-01-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install request-download-info
pnpm add request-download-info
yarn add request-download-info
bun add request-download-info
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-01-04 |
| First published | 2018-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Artur Boryś |
| Maintainers | wilkoklak |
| Keywords | request, info, progress, status |

## Links

- npm: https://www.npmjs.com/package/request-download-info
- Repository: https://github.com/wilkoklak/request-download-info
- Homepage: https://github.com/wilkoklak/request-download-info#readme
- Issues: https://github.com/wilkoklak/request-download-info/issues
- npm.io page: https://npm.io/package/request-download-info

## Dependencies (1)

- [throttleit](https://npm.io/package/throttleit.md) ^1.0.0

## Recent versions

- 1.0.2 (latest) — 2018-01-04
- 1.0.1 — 2018-01-04
- 1.0.0 — 2018-01-04

## README

# request-download-info
This module is a wrapper around [request](https://www.npmjs.com/package/request) module.

It provides ``progress`` event that shows current of the download
like it's speed, ETA, percentage etc.

## Installation

You have to install [request](https://www.npmjs.com/package/request) module:
```bash
npm install request --save
```
Then you need to install this module:
```bash
npm install request-download-info --save
```

## Usage

```js
const request = require('request')
const RequestInfo = require('request-download-info')
const fs = require('fs')

let info = new RequestInfo(
  request('http://releases.ubuntu.com/16.04.3/ubuntu-16.04.3-desktop-amd64.iso')
)
info.on('progress', status => {
  console.log(status)
}).pipe(fs.createWriteStream('ubuntu.iso'))
```

The above example downloads Ubuntu iso from official page, to ``ubuntu.iso`` in
current directory and prints status of download each second (by default).

## Documentation

See [Documentation](docs/main.md) here

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