node-uploadx

Node.js resumable upload middleware. Server-side part of ngx-uploadx Supported APIs: Google resumable v3.0, tus 1.0, multipart upload. Capable store uploads locally on disk, on Google Storage or on S3.

🌩 Installation

All-In-One:

npm install node-uploadx

Separate modules can also be used to save disk space and for faster installation process.:

• core module:

  npm install @uploadx/core

• Google Cloud Storage support:

  npm install @uploadx/gcs

• S3 support:

  npm install @uploadx/s3

♨ Usage

Express example:

const express = require('express');
const { uploadx } = require('@uploadx/core');

const app = express();
const opts = {
  directory: './files',
  onComplete: file => console.log('Upload complete: ', file)
};

app.use('/upload/files', uploadx(opts));

app.listen(3003);

Node http.Server GCS example:

const { Uploadx, GCStorage } = require('node-uploadx');
const http = require('http');
const url = require('url');

const storage = new GCStorage({ bucket: 'uploads' });
const uploads = new Uploadx({ storage });
uploads.on('completed', console.log);

const server = http
  .createServer((req, res) => {
    const pathname = url.parse(req.url).pathname;
    if (pathname === '/upload/files') {
      uploads.handle(req, res);
    } else {
      res.writeHead(404, { 'Content-Type': 'text/plan' });
      res.end('Not Found');
    }
  })
  .listen(3003);

Please navigate to the examples for more.

🛠 Options

Some available options: :

For Google Cloud Storage authenticate see GoogleAuthOptions. Also supported GCS_BUCKET, GCS_KEYFILE and GOOGLE_APPLICATION_CREDENTIALS environment variables.

For S3 buckets - Setting Credentials in Node.js and S3_BUCKET, S3_KEYFILE environment variable.

References

• https://developers.google.com/drive/api/v3/manage-uploads#resumable
• https://github.com/tus/tus-resumable-upload-protocol/blob/master/protocol.md

Contributing

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are welcome!

License

MIT