# awesome-downloader

> 下载组件

Latest version **1.0.2** (published 2019-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install awesome-downloader
pnpm add awesome-downloader
yarn add awesome-downloader
bun add awesome-downloader
```

## 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 | 2019-10-29 |
| First published | 2019-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Abot Chen |
| Maintainers | xiunen |

## Links

- npm: https://www.npmjs.com/package/awesome-downloader
- Repository: https://github.com/xiunen/download
- Homepage: https://github.com/xiunen/download#readme
- Issues: https://github.com/xiunen/download/issues
- npm.io page: https://npm.io/package/awesome-downloader

## Recent versions

- 1.0.2 (latest) — 2019-10-29
- 1.0.1 — 2019-10-29
- 1.0.0 — 2019-10-18

## README

# download
下载组件

## API

### download(filename:String, data:String) 直接下载数据
#### filename
必填，下载文件名
#### data
必填，想要下载的数据

### downloadCSV(url:String, options:Object)

#### options.perPage:Number
每次请求的数量,默认100

#### options.filename:String
下载的文件名，默认`download.csv`

### options.query:Object
请求的额外参数，默认 `{}`

### options.columns:Array
csv输出列描述，格式如:
```javascript
  [
    dataIndex: '', //必填，列key
    title:'',//列名, 默认dataIndex
    render:(value, row)=>{//数据转换函数,
      return value;
    } 
  ]
```

#### options.responseTransformer:Function=(response)=>{}

接口响应转换函数

**return**: {data:Array, total:Number} 函数应当返回的结果，data未本次请求转换的结果数组，total是需要下载的总条数

**params**: response 服务端响应体

#### options.queryTransformer:Fucntion=(query)=>{}

对query参数进行转换

**return**  {}

**params** query 请求参数， 包括 offset和limit

### options.onUpdate:Function=({data:Array, total:Number})=>{}

**data**: 所有已经从服务端拉回来的数据

**total**: 需要下载的总条数

### csvStringify(data:Array, columns:Array):String 

将数据转化成 csv格式
```javascript
  import csvStringify from 'awesome-downloader/src/csv'
```

### requestController(url:String, {limit: Number}, onUpdate: Function, responseTransformer: Function):void

请求调度器

```javascript
  import requestController from 'awesome-downloader/src/request'
```


## Example
```javascript
  import {downloadCSV} from 'awesome-downloader'
  downloadCSV(
    '/download', //required
    {
    perPage:100, //default is 100
    filename:'test.csv', // default is download.csv
    query:{ //default is empty object
      start_time:0,
      end_time: Date.now()
    },
    columns: [
      {
        dataIndex:'title',
        title:'Title',
        render(value){
          return value;
        }
      }
    ],
    responseTransfomer(response){
      return {
        data: response.data.list, 
        total: response.data.total
      }
    },
    onUpdata({data, total}){}
  })
```

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