# node-flashget

**Repository Path**: mirrors/node-flashget

## Basic Information

- **Project Name**: node-flashget
- **Description**: binary 分片下载工具，支持大文件，全平台通用
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/node-flashget
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2020-04-20
- **Last Updated**: 2025-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FlashGet
#### Parallel download module & command line tool ( largesize file supported )
FlashGet use http/https module to redirect source url and split file fragment when parallel threads download.
fs.writeStream was very smooth running on SolidStateDrive, but if on your iot device, u really need to set low currency.

[![NPM version](https://img.shields.io/npm/v/flashget.svg)](https://www.npmjs.com/package/flashget)
[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![npm](https://img.shields.io/npm/dt/flashget.svg)](https://www.npmjs.com/package/flashget)
[![node](https://img.shields.io/node/v/flashget.svg)](https://nodejs.org/en/download/)

#### In other one package, continue transfering from break point was supported, see
https://www.npmjs.com/package/fetchsource

#### Executive file published on
https://github.com/chenxianming/flashget/releases

# How to use?

## Command line tool

``` 
npm i flashget -g
``` 

flashget url -c currency threads
option -c parallel threads, if your server is hhd, recommended set 2 threads.

``` 
flashget -c 20 http://www.mirrorservice.org/sites/releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso
``` 

Or u can ignored c param, default is 3
``` 
flashget http://www.mirrorservice.org/sites/releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso
``` 

downloading( 3%) ⸨=-------------------⸩ 6060kb/s [1000/2000]


## Node module
Import flashget to your project, very easy.
```
npm i flashget
```

```
const Downloader = require('flashget');

let task = new Downloader({
    url: 'http://www.mirrorservice.org/sites/releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso',
    currency: 5, // default is 3
    output: './ubuntu-18.04.3-desktop-amd64.iso'
});

task.on('error', (err) => {
    console.log(err);
});

task.on('end', (path) => {
    console.log(`your file download here ${ path }`);
});

task.on('progress', (pro, speed) => {
    console.log('progress', pro);
    console.log('speed', speed + ' kb/s');
});

task.begin();
```

On chain called
```
new Downloader({
    url: 'http://www.mirrorservice.org/sites/releases.ubuntu.com/18.04.3/ubuntu-18.04.3-desktop-amd64.iso', // url
    currency: 5, // parallel thread
    output: './ubuntu-18.04.3-desktop-amd64.iso' // save as
})
.on('error', (err) => console.log(err) )
.on('end', (exportname) => console.log(`your file download here ${ exportname }`))
.on('progress', (progress) => console.log( progress ) )
.begin();
```

# Test

``` 
npm run test
```