rahad-all-downloader 2.1.1 → 2.1.3
Sign up to get free protection for your applications and to get access to all the features.
- package/.cache/typescript/5.4/node_modules/.package-lock.json +110 -0
- package/.cache/typescript/5.4/node_modules/@types/caseless/LICENSE +21 -0
- package/.cache/typescript/5.4/node_modules/@types/caseless/README.md +48 -0
- package/.cache/typescript/5.4/node_modules/@types/caseless/index.d.ts +29 -0
- package/.cache/typescript/5.4/node_modules/@types/caseless/package.json +35 -0
- package/.cache/typescript/5.4/node_modules/@types/node-fetch/LICENSE +21 -0
- package/.cache/typescript/5.4/node_modules/@types/node-fetch/README.md +15 -0
- package/.cache/typescript/5.4/node_modules/@types/node-fetch/externals.d.ts +32 -0
- package/.cache/typescript/5.4/node_modules/@types/node-fetch/index.d.ts +238 -0
- package/.cache/typescript/5.4/node_modules/@types/node-fetch/package.json +83 -0
- package/.cache/typescript/5.4/node_modules/@types/request/LICENSE +21 -0
- package/.cache/typescript/5.4/node_modules/@types/request/README.md +15 -0
- package/.cache/typescript/5.4/node_modules/@types/request/index.d.ts +395 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/License +19 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/README.md +350 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/README.md.bak +350 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/index.d.ts +51 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/browser.js +2 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/form_data.js +483 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/lib/populate.js +10 -0
- package/.cache/typescript/5.4/node_modules/@types/request/node_modules/form-data/package.json +68 -0
- package/.cache/typescript/5.4/node_modules/@types/request/package.json +70 -0
- package/.cache/typescript/5.4/node_modules/@types/tough-cookie/LICENSE +21 -0
- package/.cache/typescript/5.4/node_modules/@types/tough-cookie/README.md +15 -0
- package/.cache/typescript/5.4/node_modules/@types/tough-cookie/index.d.ts +321 -0
- package/.cache/typescript/5.4/node_modules/@types/tough-cookie/package.json +35 -0
- package/.cache/typescript/5.4/node_modules/asynckit/LICENSE +21 -0
- package/.cache/typescript/5.4/node_modules/asynckit/README.md +233 -0
- package/.cache/typescript/5.4/node_modules/asynckit/bench.js +76 -0
- package/.cache/typescript/5.4/node_modules/asynckit/index.js +6 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/abort.js +29 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/async.js +34 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/defer.js +26 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/iterate.js +75 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_asynckit.js +91 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_parallel.js +25 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_serial.js +25 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/readable_serial_ordered.js +29 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/state.js +37 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/streamify.js +141 -0
- package/.cache/typescript/5.4/node_modules/asynckit/lib/terminator.js +29 -0
- package/.cache/typescript/5.4/node_modules/asynckit/package.json +63 -0
- package/.cache/typescript/5.4/node_modules/asynckit/parallel.js +43 -0
- package/.cache/typescript/5.4/node_modules/asynckit/serial.js +17 -0
- package/.cache/typescript/5.4/node_modules/asynckit/serialOrdered.js +75 -0
- package/.cache/typescript/5.4/node_modules/asynckit/stream.js +21 -0
- package/.cache/typescript/5.4/node_modules/combined-stream/License +19 -0
- package/.cache/typescript/5.4/node_modules/combined-stream/Readme.md +138 -0
- package/.cache/typescript/5.4/node_modules/combined-stream/lib/combined_stream.js +208 -0
- package/.cache/typescript/5.4/node_modules/combined-stream/package.json +25 -0
- package/.cache/typescript/5.4/node_modules/combined-stream/yarn.lock +17 -0
- package/.cache/typescript/5.4/node_modules/delayed-stream/License +19 -0
- package/.cache/typescript/5.4/node_modules/delayed-stream/Makefile +7 -0
- package/.cache/typescript/5.4/node_modules/delayed-stream/Readme.md +141 -0
- package/.cache/typescript/5.4/node_modules/delayed-stream/lib/delayed_stream.js +107 -0
- package/.cache/typescript/5.4/node_modules/delayed-stream/package.json +27 -0
- package/.cache/typescript/5.4/node_modules/form-data/License +19 -0
- package/.cache/typescript/5.4/node_modules/form-data/README.md.bak +358 -0
- package/.cache/typescript/5.4/node_modules/form-data/Readme.md +358 -0
- package/.cache/typescript/5.4/node_modules/form-data/index.d.ts +62 -0
- package/.cache/typescript/5.4/node_modules/form-data/lib/browser.js +2 -0
- package/.cache/typescript/5.4/node_modules/form-data/lib/form_data.js +501 -0
- package/.cache/typescript/5.4/node_modules/form-data/lib/populate.js +10 -0
- package/.cache/typescript/5.4/node_modules/form-data/package.json +68 -0
- package/.cache/typescript/5.4/node_modules/mime-db/HISTORY.md +507 -0
- package/.cache/typescript/5.4/node_modules/mime-db/LICENSE +23 -0
- package/.cache/typescript/5.4/node_modules/mime-db/README.md +100 -0
- package/.cache/typescript/5.4/node_modules/mime-db/db.json +8519 -0
- package/.cache/typescript/5.4/node_modules/mime-db/index.js +12 -0
- package/.cache/typescript/5.4/node_modules/mime-db/package.json +60 -0
- package/.cache/typescript/5.4/node_modules/mime-types/HISTORY.md +397 -0
- package/.cache/typescript/5.4/node_modules/mime-types/LICENSE +23 -0
- package/.cache/typescript/5.4/node_modules/mime-types/README.md +113 -0
- package/.cache/typescript/5.4/node_modules/mime-types/index.js +188 -0
- package/.cache/typescript/5.4/node_modules/mime-types/package.json +44 -0
- package/.cache/typescript/5.4/package-lock.json +113 -1
- package/.cache/typescript/5.4/package.json +1 -1
- package/README.md +1 -1
- package/package.json +21 -2
@@ -0,0 +1,141 @@
|
|
1
|
+
# delayed-stream
|
2
|
+
|
3
|
+
Buffers events from a stream until you are ready to handle them.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
``` bash
|
8
|
+
npm install delayed-stream
|
9
|
+
```
|
10
|
+
|
11
|
+
## Usage
|
12
|
+
|
13
|
+
The following example shows how to write a http echo server that delays its
|
14
|
+
response by 1000 ms.
|
15
|
+
|
16
|
+
``` javascript
|
17
|
+
var DelayedStream = require('delayed-stream');
|
18
|
+
var http = require('http');
|
19
|
+
|
20
|
+
http.createServer(function(req, res) {
|
21
|
+
var delayed = DelayedStream.create(req);
|
22
|
+
|
23
|
+
setTimeout(function() {
|
24
|
+
res.writeHead(200);
|
25
|
+
delayed.pipe(res);
|
26
|
+
}, 1000);
|
27
|
+
});
|
28
|
+
```
|
29
|
+
|
30
|
+
If you are not using `Stream#pipe`, you can also manually release the buffered
|
31
|
+
events by calling `delayedStream.resume()`:
|
32
|
+
|
33
|
+
``` javascript
|
34
|
+
var delayed = DelayedStream.create(req);
|
35
|
+
|
36
|
+
setTimeout(function() {
|
37
|
+
// Emit all buffered events and resume underlaying source
|
38
|
+
delayed.resume();
|
39
|
+
}, 1000);
|
40
|
+
```
|
41
|
+
|
42
|
+
## Implementation
|
43
|
+
|
44
|
+
In order to use this meta stream properly, here are a few things you should
|
45
|
+
know about the implementation.
|
46
|
+
|
47
|
+
### Event Buffering / Proxying
|
48
|
+
|
49
|
+
All events of the `source` stream are hijacked by overwriting the `source.emit`
|
50
|
+
method. Until node implements a catch-all event listener, this is the only way.
|
51
|
+
|
52
|
+
However, delayed-stream still continues to emit all events it captures on the
|
53
|
+
`source`, regardless of whether you have released the delayed stream yet or
|
54
|
+
not.
|
55
|
+
|
56
|
+
Upon creation, delayed-stream captures all `source` events and stores them in
|
57
|
+
an internal event buffer. Once `delayedStream.release()` is called, all
|
58
|
+
buffered events are emitted on the `delayedStream`, and the event buffer is
|
59
|
+
cleared. After that, delayed-stream merely acts as a proxy for the underlaying
|
60
|
+
source.
|
61
|
+
|
62
|
+
### Error handling
|
63
|
+
|
64
|
+
Error events on `source` are buffered / proxied just like any other events.
|
65
|
+
However, `delayedStream.create` attaches a no-op `'error'` listener to the
|
66
|
+
`source`. This way you only have to handle errors on the `delayedStream`
|
67
|
+
object, rather than in two places.
|
68
|
+
|
69
|
+
### Buffer limits
|
70
|
+
|
71
|
+
delayed-stream provides a `maxDataSize` property that can be used to limit
|
72
|
+
the amount of data being buffered. In order to protect you from bad `source`
|
73
|
+
streams that don't react to `source.pause()`, this feature is enabled by
|
74
|
+
default.
|
75
|
+
|
76
|
+
## API
|
77
|
+
|
78
|
+
### DelayedStream.create(source, [options])
|
79
|
+
|
80
|
+
Returns a new `delayedStream`. Available options are:
|
81
|
+
|
82
|
+
* `pauseStream`
|
83
|
+
* `maxDataSize`
|
84
|
+
|
85
|
+
The description for those properties can be found below.
|
86
|
+
|
87
|
+
### delayedStream.source
|
88
|
+
|
89
|
+
The `source` stream managed by this object. This is useful if you are
|
90
|
+
passing your `delayedStream` around, and you still want to access properties
|
91
|
+
on the `source` object.
|
92
|
+
|
93
|
+
### delayedStream.pauseStream = true
|
94
|
+
|
95
|
+
Whether to pause the underlaying `source` when calling
|
96
|
+
`DelayedStream.create()`. Modifying this property afterwards has no effect.
|
97
|
+
|
98
|
+
### delayedStream.maxDataSize = 1024 * 1024
|
99
|
+
|
100
|
+
The amount of data to buffer before emitting an `error`.
|
101
|
+
|
102
|
+
If the underlaying source is emitting `Buffer` objects, the `maxDataSize`
|
103
|
+
refers to bytes.
|
104
|
+
|
105
|
+
If the underlaying source is emitting JavaScript strings, the size refers to
|
106
|
+
characters.
|
107
|
+
|
108
|
+
If you know what you are doing, you can set this property to `Infinity` to
|
109
|
+
disable this feature. You can also modify this property during runtime.
|
110
|
+
|
111
|
+
### delayedStream.dataSize = 0
|
112
|
+
|
113
|
+
The amount of data buffered so far.
|
114
|
+
|
115
|
+
### delayedStream.readable
|
116
|
+
|
117
|
+
An ECMA5 getter that returns the value of `source.readable`.
|
118
|
+
|
119
|
+
### delayedStream.resume()
|
120
|
+
|
121
|
+
If the `delayedStream` has not been released so far, `delayedStream.release()`
|
122
|
+
is called.
|
123
|
+
|
124
|
+
In either case, `source.resume()` is called.
|
125
|
+
|
126
|
+
### delayedStream.pause()
|
127
|
+
|
128
|
+
Calls `source.pause()`.
|
129
|
+
|
130
|
+
### delayedStream.pipe(dest)
|
131
|
+
|
132
|
+
Calls `delayedStream.resume()` and then proxies the arguments to `source.pipe`.
|
133
|
+
|
134
|
+
### delayedStream.release()
|
135
|
+
|
136
|
+
Emits and clears all events that have been buffered up so far. This does not
|
137
|
+
resume the underlaying source, use `delayedStream.resume()` instead.
|
138
|
+
|
139
|
+
## License
|
140
|
+
|
141
|
+
delayed-stream is licensed under the MIT license.
|
@@ -0,0 +1,107 @@
|
|
1
|
+
var Stream = require('stream').Stream;
|
2
|
+
var util = require('util');
|
3
|
+
|
4
|
+
module.exports = DelayedStream;
|
5
|
+
function DelayedStream() {
|
6
|
+
this.source = null;
|
7
|
+
this.dataSize = 0;
|
8
|
+
this.maxDataSize = 1024 * 1024;
|
9
|
+
this.pauseStream = true;
|
10
|
+
|
11
|
+
this._maxDataSizeExceeded = false;
|
12
|
+
this._released = false;
|
13
|
+
this._bufferedEvents = [];
|
14
|
+
}
|
15
|
+
util.inherits(DelayedStream, Stream);
|
16
|
+
|
17
|
+
DelayedStream.create = function(source, options) {
|
18
|
+
var delayedStream = new this();
|
19
|
+
|
20
|
+
options = options || {};
|
21
|
+
for (var option in options) {
|
22
|
+
delayedStream[option] = options[option];
|
23
|
+
}
|
24
|
+
|
25
|
+
delayedStream.source = source;
|
26
|
+
|
27
|
+
var realEmit = source.emit;
|
28
|
+
source.emit = function() {
|
29
|
+
delayedStream._handleEmit(arguments);
|
30
|
+
return realEmit.apply(source, arguments);
|
31
|
+
};
|
32
|
+
|
33
|
+
source.on('error', function() {});
|
34
|
+
if (delayedStream.pauseStream) {
|
35
|
+
source.pause();
|
36
|
+
}
|
37
|
+
|
38
|
+
return delayedStream;
|
39
|
+
};
|
40
|
+
|
41
|
+
Object.defineProperty(DelayedStream.prototype, 'readable', {
|
42
|
+
configurable: true,
|
43
|
+
enumerable: true,
|
44
|
+
get: function() {
|
45
|
+
return this.source.readable;
|
46
|
+
}
|
47
|
+
});
|
48
|
+
|
49
|
+
DelayedStream.prototype.setEncoding = function() {
|
50
|
+
return this.source.setEncoding.apply(this.source, arguments);
|
51
|
+
};
|
52
|
+
|
53
|
+
DelayedStream.prototype.resume = function() {
|
54
|
+
if (!this._released) {
|
55
|
+
this.release();
|
56
|
+
}
|
57
|
+
|
58
|
+
this.source.resume();
|
59
|
+
};
|
60
|
+
|
61
|
+
DelayedStream.prototype.pause = function() {
|
62
|
+
this.source.pause();
|
63
|
+
};
|
64
|
+
|
65
|
+
DelayedStream.prototype.release = function() {
|
66
|
+
this._released = true;
|
67
|
+
|
68
|
+
this._bufferedEvents.forEach(function(args) {
|
69
|
+
this.emit.apply(this, args);
|
70
|
+
}.bind(this));
|
71
|
+
this._bufferedEvents = [];
|
72
|
+
};
|
73
|
+
|
74
|
+
DelayedStream.prototype.pipe = function() {
|
75
|
+
var r = Stream.prototype.pipe.apply(this, arguments);
|
76
|
+
this.resume();
|
77
|
+
return r;
|
78
|
+
};
|
79
|
+
|
80
|
+
DelayedStream.prototype._handleEmit = function(args) {
|
81
|
+
if (this._released) {
|
82
|
+
this.emit.apply(this, args);
|
83
|
+
return;
|
84
|
+
}
|
85
|
+
|
86
|
+
if (args[0] === 'data') {
|
87
|
+
this.dataSize += args[1].length;
|
88
|
+
this._checkIfMaxDataSizeExceeded();
|
89
|
+
}
|
90
|
+
|
91
|
+
this._bufferedEvents.push(args);
|
92
|
+
};
|
93
|
+
|
94
|
+
DelayedStream.prototype._checkIfMaxDataSizeExceeded = function() {
|
95
|
+
if (this._maxDataSizeExceeded) {
|
96
|
+
return;
|
97
|
+
}
|
98
|
+
|
99
|
+
if (this.dataSize <= this.maxDataSize) {
|
100
|
+
return;
|
101
|
+
}
|
102
|
+
|
103
|
+
this._maxDataSizeExceeded = true;
|
104
|
+
var message =
|
105
|
+
'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.'
|
106
|
+
this.emit('error', new Error(message));
|
107
|
+
};
|
@@ -0,0 +1,27 @@
|
|
1
|
+
{
|
2
|
+
"author": "Felix Geisendörfer <felix@debuggable.com> (http://debuggable.com/)",
|
3
|
+
"contributors": [
|
4
|
+
"Mike Atkins <apeherder@gmail.com>"
|
5
|
+
],
|
6
|
+
"name": "delayed-stream",
|
7
|
+
"description": "Buffers events from a stream until you are ready to handle them.",
|
8
|
+
"license": "MIT",
|
9
|
+
"version": "1.0.0",
|
10
|
+
"homepage": "https://github.com/felixge/node-delayed-stream",
|
11
|
+
"repository": {
|
12
|
+
"type": "git",
|
13
|
+
"url": "git://github.com/felixge/node-delayed-stream.git"
|
14
|
+
},
|
15
|
+
"main": "./lib/delayed_stream",
|
16
|
+
"engines": {
|
17
|
+
"node": ">=0.4.0"
|
18
|
+
},
|
19
|
+
"scripts": {
|
20
|
+
"test": "make test"
|
21
|
+
},
|
22
|
+
"dependencies": {},
|
23
|
+
"devDependencies": {
|
24
|
+
"fake": "0.2.0",
|
25
|
+
"far": "0.0.1"
|
26
|
+
}
|
27
|
+
}
|
@@ -0,0 +1,19 @@
|
|
1
|
+
Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and contributors
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
4
|
+
of this software and associated documentation files (the "Software"), to deal
|
5
|
+
in the Software without restriction, including without limitation the rights
|
6
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
7
|
+
copies of the Software, and to permit persons to whom the Software is
|
8
|
+
furnished to do so, subject to the following conditions:
|
9
|
+
|
10
|
+
The above copyright notice and this permission notice shall be included in
|
11
|
+
all copies or substantial portions of the Software.
|
12
|
+
|
13
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
14
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
15
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
16
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
17
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
18
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
19
|
+
THE SOFTWARE.
|
@@ -0,0 +1,358 @@
|
|
1
|
+
# Form-Data [![NPM Module](https://img.shields.io/npm/v/form-data.svg)](https://www.npmjs.com/package/form-data) [![Join the chat at https://gitter.im/form-data/form-data](http://form-data.github.io/images/gitterbadge.svg)](https://gitter.im/form-data/form-data)
|
2
|
+
|
3
|
+
A library to create readable ```"multipart/form-data"``` streams. Can be used to submit forms and file uploads to other web applications.
|
4
|
+
|
5
|
+
The API of this library is inspired by the [XMLHttpRequest-2 FormData Interface][xhr2-fd].
|
6
|
+
|
7
|
+
[xhr2-fd]: http://dev.w3.org/2006/webapi/XMLHttpRequest-2/Overview.html#the-formdata-interface
|
8
|
+
|
9
|
+
[![Linux Build](https://img.shields.io/travis/form-data/form-data/v4.0.0.svg?label=linux:6.x-12.x)](https://travis-ci.org/form-data/form-data)
|
10
|
+
[![MacOS Build](https://img.shields.io/travis/form-data/form-data/v4.0.0.svg?label=macos:6.x-12.x)](https://travis-ci.org/form-data/form-data)
|
11
|
+
[![Windows Build](https://img.shields.io/travis/form-data/form-data/v4.0.0.svg?label=windows:6.x-12.x)](https://travis-ci.org/form-data/form-data)
|
12
|
+
|
13
|
+
[![Coverage Status](https://img.shields.io/coveralls/form-data/form-data/v4.0.0.svg?label=code+coverage)](https://coveralls.io/github/form-data/form-data?branch=master)
|
14
|
+
[![Dependency Status](https://img.shields.io/david/form-data/form-data.svg)](https://david-dm.org/form-data/form-data)
|
15
|
+
|
16
|
+
## Install
|
17
|
+
|
18
|
+
```
|
19
|
+
npm install --save form-data
|
20
|
+
```
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
In this example we are constructing a form with 3 fields that contain a string,
|
25
|
+
a buffer and a file stream.
|
26
|
+
|
27
|
+
``` javascript
|
28
|
+
var FormData = require('form-data');
|
29
|
+
var fs = require('fs');
|
30
|
+
|
31
|
+
var form = new FormData();
|
32
|
+
form.append('my_field', 'my value');
|
33
|
+
form.append('my_buffer', new Buffer(10));
|
34
|
+
form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
|
35
|
+
```
|
36
|
+
|
37
|
+
Also you can use http-response stream:
|
38
|
+
|
39
|
+
``` javascript
|
40
|
+
var FormData = require('form-data');
|
41
|
+
var http = require('http');
|
42
|
+
|
43
|
+
var form = new FormData();
|
44
|
+
|
45
|
+
http.request('http://nodejs.org/images/logo.png', function(response) {
|
46
|
+
form.append('my_field', 'my value');
|
47
|
+
form.append('my_buffer', new Buffer(10));
|
48
|
+
form.append('my_logo', response);
|
49
|
+
});
|
50
|
+
```
|
51
|
+
|
52
|
+
Or @mikeal's [request](https://github.com/request/request) stream:
|
53
|
+
|
54
|
+
``` javascript
|
55
|
+
var FormData = require('form-data');
|
56
|
+
var request = require('request');
|
57
|
+
|
58
|
+
var form = new FormData();
|
59
|
+
|
60
|
+
form.append('my_field', 'my value');
|
61
|
+
form.append('my_buffer', new Buffer(10));
|
62
|
+
form.append('my_logo', request('http://nodejs.org/images/logo.png'));
|
63
|
+
```
|
64
|
+
|
65
|
+
In order to submit this form to a web application, call ```submit(url, [callback])``` method:
|
66
|
+
|
67
|
+
``` javascript
|
68
|
+
form.submit('http://example.org/', function(err, res) {
|
69
|
+
// res – response object (http.IncomingMessage) //
|
70
|
+
res.resume();
|
71
|
+
});
|
72
|
+
|
73
|
+
```
|
74
|
+
|
75
|
+
For more advanced request manipulations ```submit()``` method returns ```http.ClientRequest``` object, or you can choose from one of the alternative submission methods.
|
76
|
+
|
77
|
+
### Custom options
|
78
|
+
|
79
|
+
You can provide custom options, such as `maxDataSize`:
|
80
|
+
|
81
|
+
``` javascript
|
82
|
+
var FormData = require('form-data');
|
83
|
+
|
84
|
+
var form = new FormData({ maxDataSize: 20971520 });
|
85
|
+
form.append('my_field', 'my value');
|
86
|
+
form.append('my_buffer', /* something big */);
|
87
|
+
```
|
88
|
+
|
89
|
+
List of available options could be found in [combined-stream](https://github.com/felixge/node-combined-stream/blob/master/lib/combined_stream.js#L7-L15)
|
90
|
+
|
91
|
+
### Alternative submission methods
|
92
|
+
|
93
|
+
You can use node's http client interface:
|
94
|
+
|
95
|
+
``` javascript
|
96
|
+
var http = require('http');
|
97
|
+
|
98
|
+
var request = http.request({
|
99
|
+
method: 'post',
|
100
|
+
host: 'example.org',
|
101
|
+
path: '/upload',
|
102
|
+
headers: form.getHeaders()
|
103
|
+
});
|
104
|
+
|
105
|
+
form.pipe(request);
|
106
|
+
|
107
|
+
request.on('response', function(res) {
|
108
|
+
console.log(res.statusCode);
|
109
|
+
});
|
110
|
+
```
|
111
|
+
|
112
|
+
Or if you would prefer the `'Content-Length'` header to be set for you:
|
113
|
+
|
114
|
+
``` javascript
|
115
|
+
form.submit('example.org/upload', function(err, res) {
|
116
|
+
console.log(res.statusCode);
|
117
|
+
});
|
118
|
+
```
|
119
|
+
|
120
|
+
To use custom headers and pre-known length in parts:
|
121
|
+
|
122
|
+
``` javascript
|
123
|
+
var CRLF = '\r\n';
|
124
|
+
var form = new FormData();
|
125
|
+
|
126
|
+
var options = {
|
127
|
+
header: CRLF + '--' + form.getBoundary() + CRLF + 'X-Custom-Header: 123' + CRLF + CRLF,
|
128
|
+
knownLength: 1
|
129
|
+
};
|
130
|
+
|
131
|
+
form.append('my_buffer', buffer, options);
|
132
|
+
|
133
|
+
form.submit('http://example.com/', function(err, res) {
|
134
|
+
if (err) throw err;
|
135
|
+
console.log('Done');
|
136
|
+
});
|
137
|
+
```
|
138
|
+
|
139
|
+
Form-Data can recognize and fetch all the required information from common types of streams (```fs.readStream```, ```http.response``` and ```mikeal's request```), for some other types of streams you'd need to provide "file"-related information manually:
|
140
|
+
|
141
|
+
``` javascript
|
142
|
+
someModule.stream(function(err, stdout, stderr) {
|
143
|
+
if (err) throw err;
|
144
|
+
|
145
|
+
var form = new FormData();
|
146
|
+
|
147
|
+
form.append('file', stdout, {
|
148
|
+
filename: 'unicycle.jpg', // ... or:
|
149
|
+
filepath: 'photos/toys/unicycle.jpg',
|
150
|
+
contentType: 'image/jpeg',
|
151
|
+
knownLength: 19806
|
152
|
+
});
|
153
|
+
|
154
|
+
form.submit('http://example.com/', function(err, res) {
|
155
|
+
if (err) throw err;
|
156
|
+
console.log('Done');
|
157
|
+
});
|
158
|
+
});
|
159
|
+
```
|
160
|
+
|
161
|
+
The `filepath` property overrides `filename` and may contain a relative path. This is typically used when uploading [multiple files from a directory](https://wicg.github.io/entries-api/#dom-htmlinputelement-webkitdirectory).
|
162
|
+
|
163
|
+
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:
|
164
|
+
|
165
|
+
``` javascript
|
166
|
+
form.submit({
|
167
|
+
host: 'example.com',
|
168
|
+
path: '/probably.php?extra=params',
|
169
|
+
auth: 'username:password'
|
170
|
+
}, function(err, res) {
|
171
|
+
console.log(res.statusCode);
|
172
|
+
});
|
173
|
+
```
|
174
|
+
|
175
|
+
In case you need to also send custom HTTP headers with the POST request, you can use the `headers` key in first parameter of `form.submit()`:
|
176
|
+
|
177
|
+
``` javascript
|
178
|
+
form.submit({
|
179
|
+
host: 'example.com',
|
180
|
+
path: '/surelynot.php',
|
181
|
+
headers: {'x-test-header': 'test-header-value'}
|
182
|
+
}, function(err, res) {
|
183
|
+
console.log(res.statusCode);
|
184
|
+
});
|
185
|
+
```
|
186
|
+
|
187
|
+
### Methods
|
188
|
+
|
189
|
+
- [_Void_ append( **String** _field_, **Mixed** _value_ [, **Mixed** _options_] )](https://github.com/form-data/form-data#void-append-string-field-mixed-value--mixed-options-).
|
190
|
+
- [_Headers_ getHeaders( [**Headers** _userHeaders_] )](https://github.com/form-data/form-data#array-getheaders-array-userheaders-)
|
191
|
+
- [_String_ getBoundary()](https://github.com/form-data/form-data#string-getboundary)
|
192
|
+
- [_Void_ setBoundary()](https://github.com/form-data/form-data#void-setboundary)
|
193
|
+
- [_Buffer_ getBuffer()](https://github.com/form-data/form-data#buffer-getbuffer)
|
194
|
+
- [_Integer_ getLengthSync()](https://github.com/form-data/form-data#integer-getlengthsync)
|
195
|
+
- [_Integer_ getLength( **function** _callback_ )](https://github.com/form-data/form-data#integer-getlength-function-callback-)
|
196
|
+
- [_Boolean_ hasKnownLength()](https://github.com/form-data/form-data#boolean-hasknownlength)
|
197
|
+
- [_Request_ submit( _params_, **function** _callback_ )](https://github.com/form-data/form-data#request-submit-params-function-callback-)
|
198
|
+
- [_String_ toString()](https://github.com/form-data/form-data#string-tostring)
|
199
|
+
|
200
|
+
#### _Void_ append( **String** _field_, **Mixed** _value_ [, **Mixed** _options_] )
|
201
|
+
Append data to the form. You can submit about any format (string, integer, boolean, buffer, etc.). However, Arrays are not supported and need to be turned into strings by the user.
|
202
|
+
```javascript
|
203
|
+
var form = new FormData();
|
204
|
+
form.append( 'my_string', 'my value' );
|
205
|
+
form.append( 'my_integer', 1 );
|
206
|
+
form.append( 'my_boolean', true );
|
207
|
+
form.append( 'my_buffer', new Buffer(10) );
|
208
|
+
form.append( 'my_array_as_json', JSON.stringify( ['bird','cute'] ) )
|
209
|
+
```
|
210
|
+
|
211
|
+
You may provide a string for options, or an object.
|
212
|
+
```javascript
|
213
|
+
// Set filename by providing a string for options
|
214
|
+
form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), 'bar.jpg' );
|
215
|
+
|
216
|
+
// provide an object.
|
217
|
+
form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), {filename: 'bar.jpg', contentType: 'image/jpeg', knownLength: 19806} );
|
218
|
+
```
|
219
|
+
|
220
|
+
#### _Headers_ getHeaders( [**Headers** _userHeaders_] )
|
221
|
+
This method adds the correct `content-type` header to the provided array of `userHeaders`.
|
222
|
+
|
223
|
+
#### _String_ getBoundary()
|
224
|
+
Return the boundary of the formData. By default, the boundary consists of 26 `-` followed by 24 numbers
|
225
|
+
for example:
|
226
|
+
```javascript
|
227
|
+
--------------------------515890814546601021194782
|
228
|
+
```
|
229
|
+
|
230
|
+
#### _Void_ setBoundary(String _boundary_)
|
231
|
+
Set the boundary string, overriding the default behavior described above.
|
232
|
+
|
233
|
+
_Note: The boundary must be unique and may not appear in the data._
|
234
|
+
|
235
|
+
#### _Buffer_ getBuffer()
|
236
|
+
Return the full formdata request package, as a Buffer. You can insert this Buffer in e.g. Axios to send multipart data.
|
237
|
+
```javascript
|
238
|
+
var form = new FormData();
|
239
|
+
form.append( 'my_buffer', Buffer.from([0x4a,0x42,0x20,0x52,0x6f,0x63,0x6b,0x73]) );
|
240
|
+
form.append( 'my_file', fs.readFileSync('/foo/bar.jpg') );
|
241
|
+
|
242
|
+
axios.post( 'https://example.com/path/to/api',
|
243
|
+
form.getBuffer(),
|
244
|
+
form.getHeaders()
|
245
|
+
)
|
246
|
+
```
|
247
|
+
**Note:** Because the output is of type Buffer, you can only append types that are accepted by Buffer: *string, Buffer, ArrayBuffer, Array, or Array-like Object*. A ReadStream for example will result in an error.
|
248
|
+
|
249
|
+
#### _Integer_ getLengthSync()
|
250
|
+
Same as `getLength` but synchronous.
|
251
|
+
|
252
|
+
_Note: getLengthSync __doesn't__ calculate streams length._
|
253
|
+
|
254
|
+
#### _Integer_ getLength( **function** _callback_ )
|
255
|
+
Returns the `Content-Length` async. The callback is used to handle errors and continue once the length has been calculated
|
256
|
+
```javascript
|
257
|
+
this.getLength(function(err, length) {
|
258
|
+
if (err) {
|
259
|
+
this._error(err);
|
260
|
+
return;
|
261
|
+
}
|
262
|
+
|
263
|
+
// add content length
|
264
|
+
request.setHeader('Content-Length', length);
|
265
|
+
|
266
|
+
...
|
267
|
+
}.bind(this));
|
268
|
+
```
|
269
|
+
|
270
|
+
#### _Boolean_ hasKnownLength()
|
271
|
+
Checks if the length of added values is known.
|
272
|
+
|
273
|
+
#### _Request_ submit( _params_, **function** _callback_ )
|
274
|
+
Submit the form to a web application.
|
275
|
+
```javascript
|
276
|
+
var form = new FormData();
|
277
|
+
form.append( 'my_string', 'Hello World' );
|
278
|
+
|
279
|
+
form.submit( 'http://example.com/', function(err, res) {
|
280
|
+
// res – response object (http.IncomingMessage) //
|
281
|
+
res.resume();
|
282
|
+
} );
|
283
|
+
```
|
284
|
+
|
285
|
+
#### _String_ toString()
|
286
|
+
Returns the form data as a string. Don't use this if you are sending files or buffers, use `getBuffer()` instead.
|
287
|
+
|
288
|
+
### Integration with other libraries
|
289
|
+
|
290
|
+
#### Request
|
291
|
+
|
292
|
+
Form submission using [request](https://github.com/request/request):
|
293
|
+
|
294
|
+
```javascript
|
295
|
+
var formData = {
|
296
|
+
my_field: 'my_value',
|
297
|
+
my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),
|
298
|
+
};
|
299
|
+
|
300
|
+
request.post({url:'http://service.com/upload', formData: formData}, function(err, httpResponse, body) {
|
301
|
+
if (err) {
|
302
|
+
return console.error('upload failed:', err);
|
303
|
+
}
|
304
|
+
console.log('Upload successful! Server responded with:', body);
|
305
|
+
});
|
306
|
+
```
|
307
|
+
|
308
|
+
For more details see [request readme](https://github.com/request/request#multipartform-data-multipart-form-uploads).
|
309
|
+
|
310
|
+
#### node-fetch
|
311
|
+
|
312
|
+
You can also submit a form using [node-fetch](https://github.com/bitinn/node-fetch):
|
313
|
+
|
314
|
+
```javascript
|
315
|
+
var form = new FormData();
|
316
|
+
|
317
|
+
form.append('a', 1);
|
318
|
+
|
319
|
+
fetch('http://example.com', { method: 'POST', body: form })
|
320
|
+
.then(function(res) {
|
321
|
+
return res.json();
|
322
|
+
}).then(function(json) {
|
323
|
+
console.log(json);
|
324
|
+
});
|
325
|
+
```
|
326
|
+
|
327
|
+
#### axios
|
328
|
+
|
329
|
+
In Node.js you can post a file using [axios](https://github.com/axios/axios):
|
330
|
+
```javascript
|
331
|
+
const form = new FormData();
|
332
|
+
const stream = fs.createReadStream(PATH_TO_FILE);
|
333
|
+
|
334
|
+
form.append('image', stream);
|
335
|
+
|
336
|
+
// In Node.js environment you need to set boundary in the header field 'Content-Type' by calling method `getHeaders`
|
337
|
+
const formHeaders = form.getHeaders();
|
338
|
+
|
339
|
+
axios.post('http://example.com', form, {
|
340
|
+
headers: {
|
341
|
+
...formHeaders,
|
342
|
+
},
|
343
|
+
})
|
344
|
+
.then(response => response)
|
345
|
+
.catch(error => error)
|
346
|
+
```
|
347
|
+
|
348
|
+
## Notes
|
349
|
+
|
350
|
+
- ```getLengthSync()``` method DOESN'T calculate length for streams, use ```knownLength``` options as workaround.
|
351
|
+
- ```getLength(cb)``` will send an error as first parameter of callback if stream length cannot be calculated (e.g. send in custom streams w/o using ```knownLength```).
|
352
|
+
- ```submit``` will not add `content-length` if form length is unknown or not calculable.
|
353
|
+
- Starting version `2.x` FormData has dropped support for `node@0.10.x`.
|
354
|
+
- Starting version `3.x` FormData has dropped support for `node@4.x`.
|
355
|
+
|
356
|
+
## License
|
357
|
+
|
358
|
+
Form-Data is released under the [MIT](License) license.
|