https://github.com/mamal72/axel-downloader

A node.js wrapper around axel downloader
https://github.com/mamal72/axel-downloader

axel download downloader

Last synced: 20 days ago
JSON representation

A node.js wrapper around axel downloader

• Host: GitHub
• URL: https://github.com/mamal72/axel-downloader
• Owner: mamal72
• License: mit
• Created: 2017-02-06T12:27:22.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-14T01:49:05.000Z (almost 8 years ago)
• Last Synced: 2024-08-10T10:39:26.510Z (3 months ago)
• Topics: axel, download, downloader
• Language: JavaScript
• Homepage:
• Size: 48.8 KB
• Stars: 9
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mamal72/axel-downloader.svg?branch=master)](https://travis-ci.org/mamal72/axel-downloader)

[![Coverage Status](https://coveralls.io/repos/github/mamal72/axel-downloader/badge.svg)](https://coveralls.io/github/mamal72/axel-downloader)

[![license](https://img.shields.io/github/license/mamal72/axel-downloader.svg)](https://github.com/mamal72/axel-downloader/blob/master/LICENSE)

# axel-downloader

A node.js wrapper around [axel downloader](https://github.com/eribertomota/axel).

## Installation

- Install [Axel](https://github.com/eribertomota/axel).

macOS

```bash

brew install axel

```

Ubuntu

```bash

sudo apt install axel

```

- Install `axel-downloader` from `npm`:

```bash

yarn add axel-downloader

# or

npm i axel-downloader -S

```

## Usage

```js

import { Download } from 'axel-downloader';

const url = 'http://somewhere-something.xyz/some-file.abc';

const downloadPath = '/home/username/Downloads'; // OPTIONAL

const options = {

  connections: 32,

  maxSpeed: 6000, // KB

  userAgent: 'Axel Bot',

  headers: [{

    key: 'token',

    value: 'n0tS0f3'

  }]

}; // OPTIONAL

const download = new Download(url, downloadPath, options);

download.on('start', () => {

  console.log('Download Started!');

});

download.on('progress', data => {

  console.log('Progress', data);

});

download.on('error', err => {

  console.log('Error', err);

});

download.on('connection-finished', data => {

  console.log('Connection Finished', data);

});

download.on('finish', () => {

  console.log('Download Finished!');

});

download.on('stop', () => {

  console.log('Download Stopped!');

});

download.start();

```

`Download` class inherits from EventEmitter. You can listen on it for `start`, `progress`, `error`, `connection-finished`, `finish`, `stop` events.

*More details will be added.*

## Tests

```bash

yarn test

# or

npm test

```

## Ideas || Issues

Just create an issue and describe it. I'll check it ASAP!

## Contribution

You can fork the repository, improve or fix some part of it and then send the pull requests back if you want to see them here. I really appreciate that. :heart:

Remember to write a few tests if you can. :wrench:

## License

> Licensed under the [MIT License](https://github.com/mamal72/axel-downloader/blob/master/LICENSE).