@jnode/request 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ npm install @jnode/request
|
|
|
13
13
|
### Import JustRequest
|
|
14
14
|
|
|
15
15
|
```javascript
|
|
16
|
-
const { request, generateMultipartBody, RequestResponse } = require('@jnode/request');
|
|
16
|
+
const { request, multipartRequest, generateMultipartBody, RequestResponse } = require('@jnode/request');
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
### Making a request
|
|
@@ -85,6 +85,35 @@ async function uploadFile() {
|
|
|
85
85
|
uploadFile();
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
+
### Making a multipart request
|
|
89
|
+
```javascript
|
|
90
|
+
const fs = require('fs');
|
|
91
|
+
|
|
92
|
+
async function uploadFile() {
|
|
93
|
+
const fileStream = fs.createReadStream('./example.txt');
|
|
94
|
+
const parts = [{
|
|
95
|
+
disposition: 'form-data; name="file"; filename="example.txt"',
|
|
96
|
+
stream: fileStream
|
|
97
|
+
}, {
|
|
98
|
+
disposition: 'form-data; name="key"',
|
|
99
|
+
data: 'value'
|
|
100
|
+
}];
|
|
101
|
+
|
|
102
|
+
const headers = {
|
|
103
|
+
'X-Custom-Header': 'custom value'
|
|
104
|
+
};
|
|
105
|
+
try {
|
|
106
|
+
const response = await multipartRequest('POST', 'https://example.com/api/upload', headers, parts);
|
|
107
|
+
console.log('Status Code:', response.statusCode);
|
|
108
|
+
console.log('Response:', response.text());
|
|
109
|
+
} catch (error) {
|
|
110
|
+
console.error('Request failed:', error);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
uploadFile();
|
|
115
|
+
```
|
|
116
|
+
|
|
88
117
|
## Functions
|
|
89
118
|
|
|
90
119
|
### `request(method, url, headers = {}, body)`
|
|
@@ -98,6 +127,24 @@ Makes an HTTP(S) request.
|
|
|
98
127
|
|
|
99
128
|
**Returns:** A Promise that resolves to a `RequestResponse` object.
|
|
100
129
|
|
|
130
|
+
### `multipartRequest(method, url, headers, parts, options)`
|
|
131
|
+
|
|
132
|
+
Makes an HTTP(S) multipart/form-data request.
|
|
133
|
+
|
|
134
|
+
- `method`: HTTP method (`POST`, `PUT`, etc.).
|
|
135
|
+
- `url`: The request URL.
|
|
136
|
+
- `headers`: An object containing request headers.
|
|
137
|
+
- `parts`: An array of objects, where each object represents a part of the form data.
|
|
138
|
+
- `disposition` (Optional): Content disposition.
|
|
139
|
+
- `type` (Optional): Content type of the data. Defaults to `application/octet-stream`.
|
|
140
|
+
- `data`: Data (string or Buffer) of this part.
|
|
141
|
+
- `file` (Optional): Path to a local file for streaming.
|
|
142
|
+
- `base64` (Optional): base64 encoded data string.
|
|
143
|
+
- `stream` (Optional): Any readable stream.
|
|
144
|
+
- `options`: Other options.
|
|
145
|
+
|
|
146
|
+
**Returns:** A Promise that resolves to a `RequestResponse` object.
|
|
147
|
+
|
|
101
148
|
### `generateMultipartBody(parts = [])`
|
|
102
149
|
|
|
103
150
|
Generates the body for a `multipart/form-data` request.
|