A multipart/form-data encoded stream, helper for file upload.

npm install formstream

var formstream = require('formstream');
var http = require('http');

var form = formstream();

// form.file('file', filepath, filename);
form.file('file', './logo.png', 'upload-logo.png');

// other form fields
form.field('foo', 'fengmk2').field('love', 'aerdeng');

// even send file content buffer directly
// form.buffer(name, buffer, filename, mimeType)
form.buffer('file2', new Buffer('This is file2 content.'), 'foo.txt');

var options = {
  method: 'POST',
  host: 'upload.cnodejs.net',
  path: '/store',
  headers: form.headers()
};
var req = http.request(options, function (res) {
  console.log('Status: %s', res.statusCode);
  res.on('data', function (data) {
    console.log(data.toString());
  });
});

form.pipe(req);

var fs = require('fs');
var formstream = require('formstream');

var filepath = './logo.png';
fs.stat(filepath, function (err, stat) {
  formstream()
    .field('status', 'share picture')
    .field('access_token', 'your access token')
    .file('pic', filepath, 'logo.png', stat.size)
    .pipe(process.stdout); // your request stream
});

Some web servers have a limit on the number of chunks, and you can set minChunkSize to ensure the size of chunk sent to the server.

var fs = require('fs');
var FormStream = require('formstream');

var filepath = './big-file.zip';
fs.stat(filepath, function (err, stat) {
  new FormStream({
    // send >= 2MB chunk buffer size to the server
    minChunkSize: 1024 * 1024 * 2,
  }).field('status', 'share file')
    .field('access_token', 'your access token')
    .file('file', filepath, 'big-file.zip', stat.size)
    .pipe(process.stdout); // your request stream
});

Create a form instance.

• options.minChunkSize Number - min chunk size to emit data event

Form - form instance

Add a normal field to the form.

• name String - Name of field
• value String - Value of field

Form - form instance

Add a local file to be uploaded to the form.

• name String - Name of file field
• filepath String - Local path of the file to be uploaded
• filename String - Optional. Name of the file (will be the base name of filepath if empty)
• filesize Number - Optional. Size of the file (will not generate Content-Length header if not specified)

Form - form instance

Add a buffer as a file to upload.

• name String - Name of field
• buffer Buffer - The buffer to be uploaded
• filename String - The file name that tells the remote server
• contentType String - Optional. Content-Type (aka. MIME Type) of content (will be infered with filename if empty)

Form - form instance

Add a readable stream as a file to upload. Event 'error' will be emitted if an error occured.

• name String - Name of field
• stream stream.Readable - A readable stream to be piped
• filename String - The file name that tells the remote server
• contentType String - Optional. Content-Type (aka. MIME Type) of content (will be infered with filename if empty)
• size Number - Optional. Size of the stream (will not generate Content-Length header if not specified)

Form - form instance

Get headers for the request.

• headers Object - Additional headers

var headers = form.headers({
  'Authorization': 'Bearer kei2akc92jmznvnkeh09sknzdk',
  'Accept': 'application/vnd.github.v3.full+json'
});

Object - Headers to be sent.

Emitted if there was an error receiving data.

The 'data' event emits when a Buffer was used.

See Node.js Documentation for more.

Emitted when the stream has received no more 'data' events will happen.

See Node.js Documentation for more.

MIT

Made with contributors-img.