https://github.com/binded/tusboy

Express middleware for the Tus resumable upload protocol
https://github.com/binded/tusboy

Last synced: about 4 hours ago
JSON representation

Express middleware for the Tus resumable upload protocol

• Host: GitHub
• URL: https://github.com/binded/tusboy
• Owner: binded
• License: mit
• Created: 2016-09-15T22:08:15.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-28T04:15:50.000Z (about 8 years ago)
• Last Synced: 2024-11-11T20:39:49.876Z (6 days ago)
• Language: JavaScript
• Homepage:
• Size: 1.13 MB
• Stars: 5
• Watchers: 9
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tusboy

[![Build Status](https://travis-ci.org/blockai/tusboy.svg?branch=master)](https://travis-ci.org/blockai/tusboy)

Express middleware for [tus resumable upload protocol](http://tus.io/).

Uses [abstract-tus-store](https://github.com/blockai/abstract-tus-store).

Name inspired by [busboy](https://github.com/mscdex/busboy).

[![tus-store-compatible](https://github.com/blockai/abstract-tus-store/raw/master/badge.png)](https://github.com/blockai/abstract-tus-store)

## Install

```bash

npm install --save tusboy

```

Requires Node v6+

## Usage

See [./test](./test) directory for usage examples.

Boilerplate example usage with s3-tus-store:

```javascript

import tusboy from 'tusboy'

import s3store from 's3-tus-store'

import aws from 'aws-sdk'

import { Passthrough } from 'stream'

import express from 'express'

const bucket = 'my-bucket'

const client = new aws.S3({

  accessKeyId: process.env.S3_ACCESS_KEY,

  secretAccessKey: process.env.S3_SECRET_KEY

})

const store = s3store({ client, bucket })

const app = express()

app

  // .use(authenticate)

  .use('/:username/avatar', new express.Router({ mergeParams: true })

    .get('/', (req, res, next) => {

      const key = `users/${req.params.username}/avatar-resized`

      const rs = store.createReadStream(key, ({ contentLength, metadata }) => {

        res.set('Content-Type', metadata.contentType)

        res.set('Content-Length', contentLength)

        rs.pipe(res)

      }).on('error', next)

    })

    .use('/upload', tusboy(store, {

      getKey: (req) => {

        // Always return same key... last successful completed upload

        // wins. Can throw here if authz error.

        const key = `users/${req.params.username}/avatar`

        return key

      },

      beforeComplete: async (req, upload, uploadId) => {},

      afterComplete: async (req, upload, completedUploadId) => {

        const key = `users/${req.params.username}/avatar`

        console.log(`Completed upload ${completedUploadId}`)

        // If you return a promise, the last patch request will

        // block until promise is resolved.

        // e.g you could resize avatar and write it to .../avatar-resized

        const rs = store.createReadStream(key)

          // .pipe(resizeImage) actually resize image...

        const resizedKey = `users/${req.params.username}/avatar-resized`

        const { uploadId } = await store.create(resizedKey, {

          metadata: upload.metadata,

          uploadLength: upload.uploadLength,

        })

        await store.append(uploadId, rs)

      },

    }))

  )

app.listen(3000)

```