Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
multi-part-lite
Advanced tools
Readme
A multi-part-lite
allows you to create multipart/form-data Stream
and Buffer
, which can be used to submit forms and file uploads to other web applications.
There are no external dependencies, so it as fast and simple as possible.
Supports: Strings
, Numbers
, Arrays
, Streams
, Buffers
and Vinyl
.
$ npm install multi-part-lite --save
Usage with got
as Stream
:
const got = require('got');
const Multipart = require('multi-part-lite');
const form = new Multipart();
form.append('photo', got.stream('https://avatars1.githubusercontent.com/u/2401029'), { filename: 'image.jpg', contentType: 'image/jpeg' });
form.append('field', 'multi-part test');
got.post('127.0.0.1:3000', { headers: form.getHeaders(), body: form.stream() });
Usage with got
as Buffer
:
const got = require('got');
const Multipart = require('multi-part-lite');
const form = new Multipart();
form.append('photo', got.stream('https://avatars1.githubusercontent.com/u/2401029'), { filename: 'image.jpg', contentType: 'image/jpeg' });
form.append('field', 'multi-part test');
(async () => {
const body = await form.buffer();
got.post('127.0.0.1:3000', { headers: form.getHeaders(false), body });
})()
Usage with http
/https
as Stream
:
const http = require('http');
const https = require('https');
const Multipart = require('multi-part-lite');
const form = new Multipart();
form.append('photo', https.request('https://avatars1.githubusercontent.com/u/2401029'), { filename: 'image.jpg', contentType: 'image/jpeg' });
form.stream().pipe(http.request({ headers: form.getHeaders(), hostname: '127.0.0.1', port: 3000, method: 'POST' }));
Usage with http
/https
as Buffer
:
const http = require('http');
const https = require('https');
const Multipart = require('multi-part-lite');
const form = new Multipart();
form.append('photo', https.request('https://avatars1.githubusercontent.com/u/2401029'), { filename: 'image.jpg', contentType: 'image/jpeg' });
(async () => {
const body = await form.buffer();
const req = http.request({ headers: form.getHeaders(false), hostname: '127.0.0.1', port: 3000, method: 'POST' });
req.end(body);
})()
Constructor.
Object
with options:
multipart
data. Ex: if equal CustomBoundary
, boundary will be equal exactly CustomBoundary
.multipart
data. Ex: if equal CustomBoundary
, boundary will be equal something like --CustomBoundary567689371204
.Object
with defaults values:
filename
is not specified in the options of .append
method. By default file
.filename
is not specified in the options of .append
method. By default bin
.contentType
is not specified in the options of .append
method. By default application/octet-stream
.Adds a new data to the multipart/form-data
stream.
photo
.String
, Number
, Array
, Buffer
, ReadableStream
or even Vynil.file.bin
will be set. Ex: anonim.jpg
.application/octet-stream
will be set. Ex: image/jpeg
.If value
is an array, append
will be called for each value:
form.append('array', [0, [2, 3], 1]);
// similar to
form.append('array', 0);
form.append('array', 2);
form.append('array', 3);
form.append('array', 1);
Null
, false
and true
will be converted to '0'
, '0'
and '1'
. Numbers will be converted to strings also.
Warning: You must specify the correct contentType
and filename
. This library doesn't validate them. You can use multi-part
library which can handle it for you.
Returns a multipart/form-data
stream.
Returns a Promise
with a buffer of the multipart/form-data
stream data.
Returns the form boundary used in the multipart/form-data
stream.
form.getBoundary(); // -> '--MultipartBoundary352840693617'
Returns the length of a buffer of the multipart/form-data
stream data.
Should be called after .buffer()
;
For .stream()
it's always 0
.
await form.buffer();
form.getLength(); // -> 12345
Returns the headers.
If you want to get correct content-length
, you should call it after .buffer()
. There is no way to know content-length
of the .stream()
, so it will be always 0
.
false
- headers will include content-length
header, otherwise there will be transfer-encoding: 'chunked'
.form.getHeaders(); // ->
//{
// 'transfer-encoding': 'chunked',
// 'content-type': 'multipart/form-data; boundary="--MultipartBoundary352840693617"'
//}
With .buffer()
:
form.getHeaders(false); // ->
//{
// 'content-length': '0',
// 'content-type': 'multipart/form-data; boundary="--MultipartBoundary352840693617"'
//}
await form.buffer();
form.getHeaders(false); // ->
//{
// 'content-length': '12345',
// 'content-type': 'multipart/form-data; boundary="--MultipartBoundary352840693617"'
//}
The MIT License (MIT)
Copyright (c) 2019 Alexey Bystrov
FAQs
Simple and fast multipart/form-data implementation without any dependencies. With Stream and Buffer modes. Supports: Strings, Numbers, Arrays, Streams, Buffers and Vinyl.
The npm package multi-part-lite receives a total of 18,621 weekly downloads. As such, multi-part-lite popularity was classified as popular.
We found that multi-part-lite demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.