https://github.com/kukhariev/node-uploadx
Node.js middleware for handling resumable uploads
https://github.com/kukhariev/node-uploadx
chunked-uploads expressjs resumable s3 tus upload uploadx
Last synced: 4 months ago
JSON representation
Node.js middleware for handling resumable uploads
- Host: GitHub
- URL: https://github.com/kukhariev/node-uploadx
- Owner: kukhariev
- License: mit
- Created: 2018-06-13T19:29:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T08:11:52.000Z (about 1 year ago)
- Last Synced: 2024-04-26T09:28:56.358Z (about 1 year ago)
- Topics: chunked-uploads, expressjs, resumable, s3, tus, upload, uploadx
- Language: TypeScript
- Homepage:
- Size: 2.81 MB
- Stars: 21
- Watchers: 2
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-uploadx
[![npm version][npm-image]][npm-url] [![Build status][gha-image]][gha-url]
[![commits since latest release][comm-image]][comm-url]
Resumable upload middleware for [express](https://github.com/expressjs/express)
and plain node.js.
Server-side part of [ngx-uploadx](https://github.com/kukhariev/ngx-uploadx)
## ⨠Features
- resumable simple/chunked uploads
- can save files to local filesystem, S3, GCS
- saving added metadata along with files
- logging and error handling
- chunks checksum verification
- file type/size/custom validations
- fixed/rolling expiration and cleanup
- extensibility (custom storages, upload protocols, etc)
## đŠī¸ Installation
All-In-One with cloud storage support:
```sh
npm install node-uploadx
```
Separate modules can also be used to save disk space and for faster installation process.:
- core module:
```sh
npm install @uploadx/core
```
- _S3_ storage support:
```sh
npm install @uploadx/s3
```
## â¨ī¸ Usage
Express example:
```js
const express = require('express');
const { uploadx } = require('@uploadx/core');
const app = express();
app.use(
'/uploads',
uploadx({
directory: './files',
maxUploadSize: '10GB',
allowMIME: ['video/*'],
onComplete: file => console.log('Upload complete: ', file)
})
);
app.listen(3003);
```
Please navigate to the [examples](examples) for more.
## đ ī¸ Options
Some available options: :
| option | type | default value | description |
| :-------------------- | :------------------: | :--------------: | ------------------------------------------------------------ |
| `directory` | `string` | `"files"` | _DiskStorage upload directory_ |
| `bucket` | `string` | `"node-uploadx"` | _Storage bucket_ |
| `path` | `string` | `"/files"` | _Node http base path_ |
| `allowMIME` | `string[]` | `["*\*"]` | _Allowed MIME types_ |
| `maxUploadSize` | `string\|number` | `"5TB"` | _File size limit_ |
| `metaStorage` | `MetaStorage` | | _Provide custom meta storage_ |
| `metaStorageConfig` | `MetaStorageOptions` | | _Configure metafiles storage_ |
| `maxMetadataSize` | `string\|number` | `"4MB"` | _Metadata size limit_ |
| `validation` | `Validation` | | _Upload validation options_ |
| `useRelativeLocation` | `boolean` | `false` | _Use relative urls_ |
| `filename` | `Function` | | _File naming function_ |
| `userIdentifier` | `UserIdentifier` | | _Get user identity_ |
| `onCreate` | `OnCreate` | | _Callback that is called when a new upload is created_ |
| `onUpdate` | `OnUpdate` | | _Callback that is called when an upload is updated_ |
| `onComplete` | `OnComplete` | | _Callback that is called when an upload is completed_ |
| `onDelete` | `OnDelete` | | _Callback that is called when an upload is cancelled_ |
| `onError` | `OnError` | | _Customize error response_ |
| `expiration` | `ExpirationOptions` | | _Configuring the cleanup of abandoned and completed uploads_ |
| `logger` | `Logger` | | _Custom logger injection_ |
| `logLevel` | `LogLevel` | `"none"` | _Set built-in logger severity level_ |
## Contributing
If you'd like to contribute, please fork the repository and make changes as you'd like.
Pull requests are welcome!
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/node-uploadx.svg
[npm-url]: https://www.npmjs.com/package/node-uploadx
[gha-image]: https://github.com/kukhariev/node-uploadx/workflows/CI/badge.svg
[gha-url]: https://github.com/kukhariev/node-uploadx
[comm-image]: https://img.shields.io/github/commits-since/kukhariev/node-uploadx/latest
[comm-url]: https://github.com/kukhariev/node-uploadx/releases/latest