Send a large file to the remote server in synchronous mode and chunked transfer.
npm i node-sendfile --save
const Sendfile = require("node-sendfile")
let sendfile = new Sendfile();
let response = await sendfile.send( "/path/large-file.gz", "https://playground.yaojs.org/yao/upload", {
params: { version:1.0 },
payload:{ name:"hello" },
progress: ( sent, total ) =>{
let percent = (sent / total * 100).toFixed(2);
console.log(`progress ${sent}/${total} ${percent}%`);
}
});
console.log( response );
| Name |
Type |
Required |
Description |
| file |
string |
true |
the local file |
| url |
string |
true |
the remote server url |
| options |
object |
false |
See Options |
| Name |
Type |
Default |
Description |
| name |
string |
"file" |
The file field name |
| chunksize |
int |
524288 |
Chunk size, default is 512kb |
| progress |
function |
(sent, total)=>{} |
Callback function for handle progress. Default is (sent, total)=>{} |
| payload |
object |
{} |
The request body Key-Value struct. Default is {} |
| params |
object |
{} |
The request query string. Key-Value struct. Default is {} |
| headers |
object |
{} |
The request header. Key-Value struct. Default is {} |
HTTP Request headers
| Name |
Format/Value |
Description |
| Content-Type: |
multipart/form-data |
|
| Content-Name: |
uM7mW6gByqIhUUN4rO8j9.tar |
The unique name of the given file |
| Content-Range |
<unit> <range-start>-<range-end>/<size> |
See Content-Range |
| Content-Disposition |
form-data; name="<field name>"; filename="<file basename>" |
See Content-Disposition |
HTTP Response definition
| Status |
Body |
Description |
| 200 |
{"path":"/storage/path/large-file.gz", "url":"https://playground.yaojs.org/static-file/path/large-file.gz"} |
Success. The response body must be JSON format text |
| 400~500 |
{"code":400,"message":"user sex required", "extra":{"fields":["sex"], "messages":{"sex":"sex required"}} } |
User Input error. The response body must be JSON format text |
| 500~600 |
{"code":500,"message":"not enough disk space"} } |
Backend error. The response body must be JSON format text |