Giter Club home page Giter Club logo

async-busboy's Introduction

Promise Based Multipart Form Parser

NPM version build status npm download

Note: This library is a fork of a fork (alqu/async-busboy) of m4nuC/async-busboy.

The typical use case for this library is when handling forms that contain file upload field(s) mixed with other inputs. Parsing logic relies on busboy. Designed for use with Koa2 and Async/Await.

Examples

Async/Await (using temp files)

import asyncBusboy from 'async-busboy';

// Koa 2 middleware
async function someFunction(ctx, next) {
  const { files, fields } = await asyncBusboy(ctx.req);

  // Make some validation on the fields before upload to S3
  if (checkFiles(fields)) {
    files.map(uploadFilesToS3);
  } else {
    return 'error';
  }
}

Async/Await (using custom onFile handler, i.e. no temp files)

import asyncBusboy from 'async-busboy';

// Koa 2 middleware
async function someFunction(ctx, next) {
  const { fields } = await asyncBusboy(ctx.req, {
    onFile: function (fieldname, file, filename, encoding, mimetype) {
      uploadFilesToS3(file);
    },
  });

  // Do validation, but files are already uploading...
  if (!checkFiles(fields)) {
    return 'error';
  }
}

ES5 with promise (using temp files)

var asyncBusboy = require('async-busboy');

function someFunction(someHTTPRequest) {
  asyncBusboy(someHTTPRequest).then(function (formData) {
    // do something with formData.files
    // do someting with formData.fields
  });
}

Async API using temp files

The request streams are first written to temporary files using os.tmpdir(). File read streams associated with the temporary files are returned from the call to async-busboy. When the consumer has drained the file read streams, the files will be automatically removed, otherwise the host OS should take care of the cleaning process.

Async API using custom onFile handler

If a custom onFile handler is specified in the options to async-busboy it will only resolve an object containing fields, but instead no temporary files needs to be created since the file stream is directly passed to the application. Note that all file streams need to be consumed for async-busboy to resolve due to the implementation of busboy. If you don't care about a received file stream, simply call stream.resume() to discard the content.

Working with nested inputs and objects

Make sure to serialize objects before sending them as formData. i.e:

// Given an object that represent the form data:
{
  field1: 'value',
  objectField: {
    key: 'anotherValue',
  },
  arrayField: ['a', 'b'],
  //...
}

Should be sent as:

// -> field1[value]
// -> objectField[key][anotherKey]
// -> arrayField[0]['a']
// -> arrayField[1]['b']
// .....

Here is a function that can take care of this process

const serializeFormData = (obj, formDataObj, namespace = null) => {
  var formDataObj = formDataObj || {};
  var formKey;
  for (var property in obj) {
    if (obj.hasOwnProperty(property)) {
      if (namespace) {
        formKey = namespace + '[' + property + ']';
      } else {
        formKey = property;
      }

      var value = obj[property];
      if (
        typeof value === 'object' &&
        !(value instanceof File) &&
        !(value instanceof Date)
      ) {
        serializeFormData(value, formDataObj, formKey);
      } else if (value instanceof Date) {
        formDataObj[formKey] = value.toISOString();
      } else {
        formDataObj[formKey] = value;
      }
    }
  }
  return formDataObj;
};

// -->

Try it on your local

If you want to run some test locally, clone this repo, then run: node examples/index.js From there you can use something like Postman to send POST request to localhost:8080. Note: When using Postman make sure to not send a Content-Type header, if it's filed by default, just delete it. (This is to let the boudary header be generated automatically)

Use cases:

  • Form sending only octet-stream (files)

  • Form sending file octet-stream (files) and input fields. a. File and fields are processed has they arrive. Their order do not matter. b. Fields must be processed (for example validated) before processing the files.

async-busboy's People

Contributors

m4nuc avatar alasdiablo avatar christensson avatar octet-stream avatar dependabot[bot] avatar amit777 avatar bodasia avatar chadkirby avatar twentyrogersc avatar dominhhai avatar jd-robbs avatar hyralm avatar loborobo avatar fireyy avatar

Watchers

François Parmentier avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.