# express-large-uploader

> express large file upload

Latest version **1.0.2** (published 2018-07-02) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install express-large-uploader
pnpm add express-large-uploader
yarn add express-large-uploader
bun add express-large-uploader
```

## 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-07-02 |
| First published | 2018-07-02 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 45.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cherokee |
| Maintainers | successage |
| Keywords | express, large, file, upload |

## Links

- npm: https://www.npmjs.com/package/express-large-uploader
- Repository: https://github.com/ahkimkoo/express-large-uploader
- Homepage: https://github.com/ahkimkoo/express-large-uploader#readme
- Issues: https://github.com/ahkimkoo/express-large-uploader/issues
- npm.io page: https://npm.io/package/express-large-uploader

## Dependencies (3)

- [fs-extra](https://npm.io/package/fs-extra.md) ^6.0.1
- [formidable](https://npm.io/package/formidable.md) ^1.2.1
- [concat-files](https://npm.io/package/concat-files.md) ^0.1.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2018-07-02
- 1.0.1 — 2018-07-02
- 1.0.0 — 2018-07-02

## README

#大文件上传控件使用帮助

基于express的大文件上传组件，使用HTML5 的File API对文件分片上传到服务端，支持断点续传。

## 一、运行DEMO

```shell
git clone https://gitee.com/dreamidea/express-large-uploader.git
cd express-large-uploader
npm install
npm run test
```

在浏览器打开http://localhost:8888/upload/client/file-upload-demo.html 查看DEMO。

## 二、与express集成

### 1、服务端

安装模块

```shell
npm install express-large-uploader --save
```

在express中引入模块

```javascript
const FileUpload = require('express-large-uploader');
app.use(FileUpload({
        'prefix' : '/upload/',
        'uploadDir' : '/data/put_upload_files_here',
        'uploadTempDir' : '/data/put_upload_files_here/tmp'
 }))
```
其中prefix是url前缀，主要是前端js引用时用到, uploadDir是上传的文件存放位置, uploadTempDir是分片文件存放的位置，如果不指定默认在uploadDir下的tmp文件夹

### 2、前端

在页面尾部中引入js
```html
<script type="text/javascript" src="/upload/file-upload.js"></script>
```
路径中的upload对应的就是服务端设置的prefix

页面中使用控件：

```html
<input type="text" name="file" id="file"/>
<input type="button" name="tg" id="tg" value="上传大文件" upload-ref="#file" upload-conf-keepname="false" />
```
有upload-ref属性的元素点击事件会触发文件上传的动作，upload-ref的值就是上传结果（文件名）存放的元素（一般是文本表单,不要使用file类型）。upload-conf-keepname表示上传时是否保持文件名，如果为false上传时将md5 hash作为文件名。

打开前端示例：http://ip:port/upload/client/file-upload-demo.html, upload对应的就是服务端设置的prefix

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