A library to create readable
"multipart/form-data" streams. Can be used to submit forms and file uploads to other web applications.
The API of this library is inspired by the XMLHttpRequest-2 FormData Interface.
npm install --save form-data
In this example we are constructing a form with 3 fields that contain a string, a buffer and a file stream.
var FormData = ;var fs = ;var form = ;form;form;form;
Also you can use http-response stream:
var FormData = ;var http = ;var form = ;http;
Or @mikeal's request stream:
var FormData = ;var request = ;var form = ;form;form;form;
In order to submit this form to a web application, call
submit(url, [callback]) method:
For more advanced request manipulations
submit() method returns
http.ClientRequest object, or you can choose from one of the alternative submission methods.
You can provide custom options, such as
var FormData = ;var form = maxDataSize: 20971520 ;form;form;
List of available options could be found in combined-stream
Alternative submission methods
You can use node's http client interface:
var http = ;var request = http;form;request;
Or if you would prefer the
'Content-Length' header to be set for you:
To use custom headers and pre-known length in parts:
var CRLF = '\r\n';var form = ;var options =header: CRLF + '--' + form + CRLF + 'X-Custom-Header: 123' + CRLF + CRLFknownLength: 1;form;form;
Form-Data can recognize and fetch all the required information from common types of streams (
mikeal's request), for some other types of streams you'd need to provide "file"-related information manually:
filepath property overrides
filename and may contain a relative path. This is typically used when uploading multiple files from a directory.
For edge cases, like POST request to URL with query string or to pass HTTP auth credentials, object can be passed to
form.submit() as first parameter:
In case you need to also send custom HTTP headers with the POST request, you can use the
headers key in first parameter of
Integration with other libraries
Form submission using request:
var formData =my_field: 'my_value'my_file: fs;request;
For more details see request readme.
You can also submit a form using node-fetch:
var form = ;form;;
getLengthSync()method DOESN'T calculate length for streams, use
knownLengthoptions as workaround.
- Starting version
2.xFormData has dropped support for
Form-Data is released under the MIT license.