# nightmare-download-manager

> Add download management to NightmareJS

Latest version **0.2.5** (published 2018-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install nightmare-download-manager
pnpm add nightmare-download-manager
yarn add nightmare-download-manager
bun add nightmare-download-manager
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2018-03-01 |
| First published | 2016-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Author | Ross Hinkley |
| Maintainers | rosshinkley |
| Keywords | nightmare, phantomjs, download, downloads |

## Links

- npm: https://www.npmjs.com/package/nightmare-download-manager
- Repository: https://github.com/rosshinkley/nightmare-download-manager
- Homepage: https://github.com/rosshinkley/nightmare-download-manager#readme
- Issues: https://github.com/rosshinkley/nightmare-download-manager/issues
- npm.io page: https://npm.io/package/nightmare-download-manager

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [sliced](https://npm.io/package/sliced.md) ^1.0.1

## Recent versions

- 0.2.5 (latest) — 2018-03-01
- 0.2.4 — 2017-02-12
- 0.2.3 — 2017-01-05
- 0.2.2 — 2016-10-04
- 0.2.1 — 2016-06-21
- 0.2.0 — 2016-05-22
- 0.1.1 — 2016-04-08
- 0.1.0 — 2016-04-02

## README

nightmare-download-manager
======================

Add download management to your [Nightmare](http://github.com/segmentio/nightmare) scripts.

# Important Note
If you want to have downloads be managed serially, check out the [Nightmare inline download plugin](https://github.com/rosshinkley/nightmare-inline-download).

## Usage
Require the library and pass the Nightmare library as a reference to attach the plugin actions:

```js
var Nightmare = require('Nightmare');
require('nightmare-download-manager')(Nightmare);
```
... and then enable the download manager with `.downloadManager()`.  It should be the first call in your Nightmare chain.

### .downloadManager()
Sets up the download management event handling.

### .waitDownloadsComplete()
Waits until all files currently downloading are in a state of `'completed'`, `'interrupted'`, or `'cancelled'`.

### .on('download', function(state, downloadItem) 
This event is triggered when Electron emits `'will-download'`.  This event is also emitted after downloads are started when [`DownloadItem`](https://github.com/atom/electron/blob/master/docs/api/download-item.md) emits `'updated'` or `'done'`.   The possible values for `state` are `'started'`, `'cancelled'`, `'interrupted'`, or `'completed'`.  Note that by listening to `'download'`, Nightmare expects the default download behavior to be overridden. 

### .emit('download', [path|action,] downloadItem)
Allows for downloads to be saved to a custom location, cancelled, or any other custom behavior.  The possible values for `action` are `'cancel'`, `'continue'` for default behavior, or a file path (file name and extension inclusive) to save the download to an alternative location. The `downloadItem` parameter should use the `downloadItem` passed by `'download'`.

## Additional Nightmare Options

### ignoreDownloads
Defines whether or not all downloads should be ignored.  By default, all downloads are accepted.

### downloadTimeout
This will throw an exception if the `.waitDownloadsComplete()` didn't finish within the set timeframe.  By default, this is not set, meaning there is no timeout. In milliseconds.

### downloadResponseWait
Defines the length of time to wait for a download response in milliseconds.  Defaults to 3s.

### paths.downloads
Sets the Electron path for where downloads are saved.

## Example

```javascript
var Nightmare = require('nightmare');
require('nightmare-download-manager')(Nightmare);
var nightmare = Nightmare();
nightmare.on('download', function(state, downloadItem){
  if(state == 'started'){
    nightmare.emit('download', '/some/path/file.zip', downloadItem);
  }
});

nightmare
  .downloadManager()
  .goto('https://github.com/segmentio/nightmare')
  .click('a[href="/segmentio/nightmare/archive/master.zip"]')
  .waitDownloadsComplete()
  .then(() => {
    console.log('done');
  })
```

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