@tachybase/module-workflow 1.3.19 → 1.3.20

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.
@@ -1 +1 @@
1
- {"author":"Felix Geisendörfer <felix@debuggable.com> (http://debuggable.com/)","name":"form-data","description":"A library to create readable \"multipart/form-data\" streams. Can be used to submit forms and file uploads to other web applications.","version":"4.0.3","repository":{"type":"git","url":"git://github.com/form-data/form-data.git"},"main":"./lib/form_data","browser":"./lib/browser","typings":"./index.d.ts","scripts":{"pretest":"npm run lint","pretests-only":"rimraf coverage test/tmp","tests-only":"istanbul cover test/run.js","posttests-only":"istanbul report lcov text","test":"npm run tests-only","posttest":"npx npm@'>=10.2' audit --production","lint":"eslint --ext=js,mjs .","report":"istanbul report lcov text","ci-lint":"is-node-modern 8 && npm run lint || is-node-not-modern 8","ci-test":"npm run tests-only && npm run browser && npm run report","predebug":"rimraf coverage test/tmp","debug":"verbose=1 ./test/run.js","browser":"browserify -t browserify-istanbul test/run-browser.js | obake --coverage","check":"istanbul check-coverage coverage/coverage*.json","files":"pkgfiles --sort=name","get-version":"node -e \"console.log(require('./package.json').version)\"","update-readme":"sed -i.bak 's/\\/master\\.svg/\\/v'$(npm --silent run get-version)'.svg/g' README.md","restore-readme":"mv README.md.bak README.md","prepublish":"not-in-publish || npm run prepublishOnly","prepublishOnly":"npm run update-readme","postpublish":"npm run restore-readme"},"engines":{"node":">= 6"},"dependencies":{"asynckit":"^0.4.0","combined-stream":"^1.0.8","es-set-tostringtag":"^2.1.0","hasown":"^2.0.2","mime-types":"^2.1.12"},"devDependencies":{"@ljharb/eslint-config":"^21.1.1","browserify":"^13.3.0","browserify-istanbul":"^2.0.0","coveralls":"^3.1.1","cross-spawn":"^6.0.6","eslint":"=8.8.0","fake":"^0.2.2","far":"^0.0.7","formidable":"^1.2.6","in-publish":"^2.0.1","is-node-modern":"^1.0.0","istanbul":"^0.4.5","obake":"^0.1.2","pkgfiles":"^2.3.2","request":"~2.87.0","rimraf":"^2.7.1","tape":"^5.9.0"},"license":"MIT","_lastModified":"2025-07-17T11:00:50.777Z"}
1
+ {"author":"Felix Geisendörfer <felix@debuggable.com> (http://debuggable.com/)","name":"form-data","description":"A library to create readable \"multipart/form-data\" streams. Can be used to submit forms and file uploads to other web applications.","version":"4.0.4","repository":{"type":"git","url":"git://github.com/form-data/form-data.git"},"main":"./lib/form_data","browser":"./lib/browser","typings":"./index.d.ts","scripts":{"pretest":"npm run lint","pretests-only":"rimraf coverage test/tmp","tests-only":"istanbul cover test/run.js","posttests-only":"istanbul report lcov text","test":"npm run tests-only","posttest":"npx npm@'>=10.2' audit --production","lint":"eslint --ext=js,mjs .","report":"istanbul report lcov text","ci-lint":"is-node-modern 8 && npm run lint || is-node-not-modern 8","ci-test":"npm run tests-only && npm run browser && npm run report","predebug":"rimraf coverage test/tmp","debug":"verbose=1 ./test/run.js","browser":"browserify -t browserify-istanbul test/run-browser.js | obake --coverage","check":"istanbul check-coverage coverage/coverage*.json","files":"pkgfiles --sort=name","get-version":"node -e \"console.log(require('./package.json').version)\"","update-readme":"sed -i.bak 's/\\/master\\.svg/\\/v'$(npm --silent run get-version)'.svg/g' README.md","postupdate-readme":"mv README.md.bak READ.ME.md.bak","restore-readme":"mv READ.ME.md.bak README.md","prepublish":"not-in-publish || npm run prepublishOnly","prepack":"npm run update-readme","postpack":"npm run restore-readme","version":"auto-changelog && git add CHANGELOG.md","postversion":"auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""},"engines":{"node":">= 6"},"dependencies":{"asynckit":"^0.4.0","combined-stream":"^1.0.8","es-set-tostringtag":"^2.1.0","hasown":"^2.0.2","mime-types":"^2.1.12"},"devDependencies":{"@ljharb/eslint-config":"^21.2.0","auto-changelog":"^2.5.0","browserify":"^13.3.0","browserify-istanbul":"^2.0.0","coveralls":"^3.1.1","cross-spawn":"^6.0.6","eslint":"=8.8.0","fake":"^0.2.2","far":"^0.0.7","formidable":"^1.2.6","in-publish":"^2.0.1","is-node-modern":"^1.0.0","istanbul":"^0.4.5","obake":"^0.1.2","pkgfiles":"^2.3.2","pre-commit":"^1.2.2","predict-v8-randomness":"^1.0.35","puppeteer":"^1.20.0","request":"~2.87.0","rimraf":"^2.7.1","semver":"^6.3.1","tape":"^5.9.0"},"license":"MIT","auto-changelog":{"output":"CHANGELOG.md","template":"keepachangelog","unreleased":false,"commitLimit":false,"backfillLimit":false,"hideCredit":true},"_lastModified":"2025-07-24T06:29:41.529Z"}
@@ -1 +1 @@
1
- {"name":"jsonata","version":"2.0.6","description":"JSON query and transformation language","module":"jsonata.js","main":"jsonata.js","typings":"jsonata.d.ts","homepage":"http://jsonata.org/","repository":{"type":"git","url":"https://github.com/jsonata-js/jsonata.git"},"scripts":{"pretest":"npm run lint","mocha":"nyc ./node_modules/mocha/bin/_mocha -- \"test/**/*.js\"","test":"npm run mocha","posttest":"npm run check-coverage && npm run browserify && npm run minify && npm run build-es5","build-es5":"npm run mkdir-dist && npm run regenerator && npm run browserify-es5 && npm run minify-es5","check-coverage":"nyc check-coverage --statements 100 --branches 100 --functions 100 --lines 100","browserify":"browserify src/jsonata.js --outfile jsonata.js --standalone jsonata","mkdir-dist":"mkdirp ./dist","regenerator":"babel src --out-dir dist --presets=@babel/env","browserify-es5":"regenerator --include-runtime polyfill.js > jsonata-es5.js; browserify dist/jsonata.js --standalone jsonata >> jsonata-es5.js","prepublishOnly":"npm run browserify && npm run minify && npm run build-es5","lint":"eslint src","doc":"jsdoc --configure jsdoc.json .","cover":"nyc _mocha","minify":"uglifyjs jsonata.js -o jsonata.min.js --compress --mangle","minify-es5":"uglifyjs jsonata-es5.js -o jsonata-es5.min.js --compress --mangle"},"license":"MIT","keywords":["JSON","query","transformation","transform","mapping","path"],"devDependencies":{"@babel/cli":"^7.8.4","@babel/core":"^7.8.4","@babel/preset-env":"^7.8.4","browserify":"^16.5.0","chai":"^4.2.0","chai-as-promised":"^7.1.1","eslint":"8.0.0","eslint-plugin-ideal":"^0.1.3","eslint-plugin-promise":"^6.0.0","jsdoc":"^3.6.3","mkdirp":"^1.0.3","mocha":"^7.0.1","mocha-lcov-reporter":"^1.3.0","nyc":"^15.1.0","regenerator":"^0.14.4","request":"^2.88.2","uglify-es":"^3.3.10"},"engines":{"node":">= 8"},"_lastModified":"2025-07-17T11:00:51.789Z"}
1
+ {"name":"jsonata","version":"2.0.6","description":"JSON query and transformation language","module":"jsonata.js","main":"jsonata.js","typings":"jsonata.d.ts","homepage":"http://jsonata.org/","repository":{"type":"git","url":"https://github.com/jsonata-js/jsonata.git"},"scripts":{"pretest":"npm run lint","mocha":"nyc ./node_modules/mocha/bin/_mocha -- \"test/**/*.js\"","test":"npm run mocha","posttest":"npm run check-coverage && npm run browserify && npm run minify && npm run build-es5","build-es5":"npm run mkdir-dist && npm run regenerator && npm run browserify-es5 && npm run minify-es5","check-coverage":"nyc check-coverage --statements 100 --branches 100 --functions 100 --lines 100","browserify":"browserify src/jsonata.js --outfile jsonata.js --standalone jsonata","mkdir-dist":"mkdirp ./dist","regenerator":"babel src --out-dir dist --presets=@babel/env","browserify-es5":"regenerator --include-runtime polyfill.js > jsonata-es5.js; browserify dist/jsonata.js --standalone jsonata >> jsonata-es5.js","prepublishOnly":"npm run browserify && npm run minify && npm run build-es5","lint":"eslint src","doc":"jsdoc --configure jsdoc.json .","cover":"nyc _mocha","minify":"uglifyjs jsonata.js -o jsonata.min.js --compress --mangle","minify-es5":"uglifyjs jsonata-es5.js -o jsonata-es5.min.js --compress --mangle"},"license":"MIT","keywords":["JSON","query","transformation","transform","mapping","path"],"devDependencies":{"@babel/cli":"^7.8.4","@babel/core":"^7.8.4","@babel/preset-env":"^7.8.4","browserify":"^16.5.0","chai":"^4.2.0","chai-as-promised":"^7.1.1","eslint":"8.0.0","eslint-plugin-ideal":"^0.1.3","eslint-plugin-promise":"^6.0.0","jsdoc":"^3.6.3","mkdirp":"^1.0.3","mocha":"^7.0.1","mocha-lcov-reporter":"^1.3.0","nyc":"^15.1.0","regenerator":"^0.14.4","request":"^2.88.2","uglify-es":"^3.3.10"},"engines":{"node":">= 8"},"_lastModified":"2025-07-24T06:29:42.520Z"}
@@ -1 +1 @@
1
- {"type":"commonjs","_lastModified":"2025-07-17T11:00:50.400Z"}
1
+ {"type":"commonjs","_lastModified":"2025-07-24T06:29:41.152Z"}
@@ -1 +1 @@
1
- {"name":"mime-types","description":"The ultimate javascript content-type utility.","version":"2.1.35","contributors":["Douglas Christopher Wilson <doug@somethingdoug.com>","Jeremiah Senkpiel <fishrock123@rocketmail.com> (https://searchbeam.jit.su)","Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"],"license":"MIT","keywords":["mime","types"],"repository":"jshttp/mime-types","dependencies":{"mime-db":"1.52.0"},"devDependencies":{"eslint":"7.32.0","eslint-config-standard":"14.1.1","eslint-plugin-import":"2.25.4","eslint-plugin-markdown":"2.2.1","eslint-plugin-node":"11.1.0","eslint-plugin-promise":"5.2.0","eslint-plugin-standard":"4.1.0","mocha":"9.2.2","nyc":"15.1.0"},"files":["HISTORY.md","LICENSE","index.js"],"engines":{"node":">= 0.6"},"scripts":{"lint":"eslint .","test":"mocha --reporter spec test/test.js","test-ci":"nyc --reporter=lcov --reporter=text npm test","test-cov":"nyc --reporter=html --reporter=text npm test"},"_lastModified":"2025-07-17T11:00:50.940Z"}
1
+ {"name":"mime-types","description":"The ultimate javascript content-type utility.","version":"2.1.35","contributors":["Douglas Christopher Wilson <doug@somethingdoug.com>","Jeremiah Senkpiel <fishrock123@rocketmail.com> (https://searchbeam.jit.su)","Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"],"license":"MIT","keywords":["mime","types"],"repository":"jshttp/mime-types","dependencies":{"mime-db":"1.52.0"},"devDependencies":{"eslint":"7.32.0","eslint-config-standard":"14.1.1","eslint-plugin-import":"2.25.4","eslint-plugin-markdown":"2.2.1","eslint-plugin-node":"11.1.0","eslint-plugin-promise":"5.2.0","eslint-plugin-standard":"4.1.0","mocha":"9.2.2","nyc":"15.1.0"},"files":["HISTORY.md","LICENSE","index.js"],"engines":{"node":">= 0.6"},"scripts":{"lint":"eslint .","test":"mocha --reporter spec test/test.js","test-ci":"nyc --reporter=lcov --reporter=text npm test","test-cov":"nyc --reporter=html --reporter=text npm test"},"_lastModified":"2025-07-24T06:29:41.690Z"}
@@ -1 +1 @@
1
- {"name":"qrcode","description":"QRCode / 2d Barcode api with both server side and client side support using canvas","version":"1.5.4","author":"Ryan Day <soldair@gmail.com>","contributors":["Vincenzo Greco <greco.vincenzo@gmail.com>","Linus Unnebäck <linus@folkdatorn.se>"],"keywords":["qr","code","canvas","qrcode"],"main":"./lib/index.js","browser":{"./lib/index.js":"./lib/browser.js","fs":false},"files":["bin","build","lib","helper"],"homepage":"http://github.com/soldair/node-qrcode","license":"MIT","scripts":{"lint":"standard","pretest":"npm run lint","test":"node --throw-deprecation test.js","build":"rollup -c","prepublish":"npm run build","browser":"node examples/clientsideserver.js"},"bin":{"qrcode":"./bin/qrcode"},"dependencies":{"dijkstrajs":"^1.0.1","pngjs":"^5.0.0","yargs":"^15.3.1"},"devDependencies":{"@babel/core":"^7.9.0","@babel/preset-env":"^7.9.5","@rollup/plugin-commonjs":"^11.1.0","@rollup/plugin-node-resolve":"^7.1.3","browserify":"^16.5.1","canvas":"^2.8.0","canvasutil":"0.0.4","colors":"^1.4.0","express":"^4.17.1","htmlparser2":"^4.1.0","rollup":"^2.6.1","rollup-plugin-babel":"^4.4.0","rollup-plugin-terser":"^5.3.0","sinon":"^9.0.2","standard":"^16.0.4","tap":"^16.2.0"},"repository":{"type":"git","url":"git://github.com/soldair/node-qrcode.git"},"engines":{"node":">=10.13.0"},"standard":{"ignore":["build/","examples/vendors/","lib/core/regex.js"]},"_lastModified":"2025-07-17T11:00:51.368Z"}
1
+ {"name":"qrcode","description":"QRCode / 2d Barcode api with both server side and client side support using canvas","version":"1.5.4","author":"Ryan Day <soldair@gmail.com>","contributors":["Vincenzo Greco <greco.vincenzo@gmail.com>","Linus Unnebäck <linus@folkdatorn.se>"],"keywords":["qr","code","canvas","qrcode"],"main":"./lib/index.js","browser":{"./lib/index.js":"./lib/browser.js","fs":false},"files":["bin","build","lib","helper"],"homepage":"http://github.com/soldair/node-qrcode","license":"MIT","scripts":{"lint":"standard","pretest":"npm run lint","test":"node --throw-deprecation test.js","build":"rollup -c","prepublish":"npm run build","browser":"node examples/clientsideserver.js"},"bin":{"qrcode":"./bin/qrcode"},"dependencies":{"dijkstrajs":"^1.0.1","pngjs":"^5.0.0","yargs":"^15.3.1"},"devDependencies":{"@babel/core":"^7.9.0","@babel/preset-env":"^7.9.5","@rollup/plugin-commonjs":"^11.1.0","@rollup/plugin-node-resolve":"^7.1.3","browserify":"^16.5.1","canvas":"^2.8.0","canvasutil":"0.0.4","colors":"^1.4.0","express":"^4.17.1","htmlparser2":"^4.1.0","rollup":"^2.6.1","rollup-plugin-babel":"^4.4.0","rollup-plugin-terser":"^5.3.0","sinon":"^9.0.2","standard":"^16.0.4","tap":"^16.2.0"},"repository":{"type":"git","url":"git://github.com/soldair/node-qrcode.git"},"engines":{"node":">=10.13.0"},"standard":{"ignore":["build/","examples/vendors/","lib/core/regex.js"]},"_lastModified":"2025-07-24T06:29:42.111Z"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tachybase/module-workflow",
3
3
  "displayName": "Workflow",
4
- "version": "1.3.19",
4
+ "version": "1.3.20",
5
5
  "description": "A powerful BPM tool that provides foundational support for business automation, with the capability to extend unlimited triggers and nodes.",
6
6
  "keywords": [
7
7
  "Workflow"
@@ -19,13 +19,13 @@
19
19
  "@types/babel__core": "7.20.5",
20
20
  "@types/ejs": "^3.1.5",
21
21
  "@types/file-saver": "^2.0.7",
22
- "@types/lodash": "^4.17.13",
22
+ "@types/lodash": "^4.17.20",
23
23
  "@types/qrcode": "^1.5.5",
24
24
  "antd": "5.22.5",
25
25
  "axios": "1.7.7",
26
26
  "cron-parser": "4.9.0",
27
27
  "file-saver": "^2.0.5",
28
- "form-data": "^4.0.3",
28
+ "form-data": "^4.0.4",
29
29
  "jsonata": "^2.0.6",
30
30
  "lodash": "4.17.21",
31
31
  "lru-cache": "11.1.0",
@@ -36,25 +36,25 @@
36
36
  "react-js-cron": "^3.2.0",
37
37
  "react-router-dom": "6.28.1",
38
38
  "sequelize": "^6.37.5",
39
- "@tachybase/components": "1.3.19",
40
- "@tachybase/plugin-workflow-test": "1.3.19"
39
+ "@tachybase/components": "1.3.20",
40
+ "@tachybase/plugin-workflow-test": "1.3.20"
41
41
  },
42
42
  "peerDependencies": {
43
- "@tachybase/actions": "1.3.19",
44
- "@tachybase/client": "1.3.19",
45
- "@tachybase/data-source": "1.3.19",
46
- "@tachybase/database": "1.3.19",
47
- "@tachybase/evaluators": "1.3.19",
48
- "@tachybase/logger": "1.3.19",
49
- "@tachybase/module-collection": "1.3.19",
50
- "@tachybase/module-error-handler": "1.3.19",
51
- "@tachybase/module-user": "1.3.19",
52
- "@tachybase/module-ui-schema": "1.3.19",
53
- "@tachybase/server": "1.3.19",
54
- "@tachybase/schema": "1.3.19",
55
- "@tachybase/resourcer": "1.3.19",
56
- "@tachybase/test": "1.3.19",
57
- "@tachybase/utils": "1.3.19"
43
+ "@tachybase/actions": "1.3.20",
44
+ "@tachybase/client": "1.3.20",
45
+ "@tachybase/data-source": "1.3.20",
46
+ "@tachybase/database": "1.3.20",
47
+ "@tachybase/evaluators": "1.3.20",
48
+ "@tachybase/module-collection": "1.3.20",
49
+ "@tachybase/logger": "1.3.20",
50
+ "@tachybase/module-ui-schema": "1.3.20",
51
+ "@tachybase/module-error-handler": "1.3.20",
52
+ "@tachybase/module-user": "1.3.20",
53
+ "@tachybase/resourcer": "1.3.20",
54
+ "@tachybase/schema": "1.3.20",
55
+ "@tachybase/test": "1.3.20",
56
+ "@tachybase/server": "1.3.20",
57
+ "@tachybase/utils": "1.3.20"
58
58
  },
59
59
  "description.zh-CN": "一个强大的 BPM 工具,为业务自动化提供基础支持,并且可任意扩展更多的触发器和节点。",
60
60
  "displayName.zh-CN": "工作流",
@@ -1,355 +0,0 @@
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/master.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/master.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/master.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/master.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', form.getBuffer(), form.getHeaders());
243
- ```
244
- **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.
245
-
246
- #### _Integer_ getLengthSync()
247
- Same as `getLength` but synchronous.
248
-
249
- _Note: getLengthSync __doesn't__ calculate streams length._
250
-
251
- #### _Integer_ getLength(**function** _callback_ )
252
- Returns the `Content-Length` async. The callback is used to handle errors and continue once the length has been calculated
253
- ```javascript
254
- this.getLength(function (err, length) {
255
- if (err) {
256
- this._error(err);
257
- return;
258
- }
259
-
260
- // add content length
261
- request.setHeader('Content-Length', length);
262
-
263
- ...
264
- }.bind(this));
265
- ```
266
-
267
- #### _Boolean_ hasKnownLength()
268
- Checks if the length of added values is known.
269
-
270
- #### _Request_ submit(_params_, **function** _callback_ )
271
- Submit the form to a web application.
272
- ```javascript
273
- var form = new FormData();
274
- form.append('my_string', 'Hello World');
275
-
276
- form.submit('http://example.com/', function (err, res) {
277
- // res – response object (http.IncomingMessage) //
278
- res.resume();
279
- } );
280
- ```
281
-
282
- #### _String_ toString()
283
- Returns the form data as a string. Don't use this if you are sending files or buffers, use `getBuffer()` instead.
284
-
285
- ### Integration with other libraries
286
-
287
- #### Request
288
-
289
- Form submission using [request](https://github.com/request/request):
290
-
291
- ```javascript
292
- var formData = {
293
- my_field: 'my_value',
294
- my_file: fs.createReadStream(__dirname + '/unicycle.jpg'),
295
- };
296
-
297
- request.post({url:'http://service.com/upload', formData: formData}, function (err, httpResponse, body) {
298
- if (err) {
299
- return console.error('upload failed:', err);
300
- }
301
- console.log('Upload successful! Server responded with:', body);
302
- });
303
- ```
304
-
305
- For more details see [request readme](https://github.com/request/request#multipartform-data-multipart-form-uploads).
306
-
307
- #### node-fetch
308
-
309
- You can also submit a form using [node-fetch](https://github.com/bitinn/node-fetch):
310
-
311
- ```javascript
312
- var form = new FormData();
313
-
314
- form.append('a', 1);
315
-
316
- fetch('http://example.com', { method: 'POST', body: form })
317
- .then(function (res) {
318
- return res.json();
319
- }).then(function (json) {
320
- console.log(json);
321
- });
322
- ```
323
-
324
- #### axios
325
-
326
- In Node.js you can post a file using [axios](https://github.com/axios/axios):
327
- ```javascript
328
- const form = new FormData();
329
- const stream = fs.createReadStream(PATH_TO_FILE);
330
-
331
- form.append('image', stream);
332
-
333
- // In Node.js environment you need to set boundary in the header field 'Content-Type' by calling method `getHeaders`
334
- const formHeaders = form.getHeaders();
335
-
336
- axios.post('http://example.com', form, {
337
- headers: {
338
- ...formHeaders,
339
- },
340
- })
341
- .then(response => response)
342
- .catch(error => error)
343
- ```
344
-
345
- ## Notes
346
-
347
- - ```getLengthSync()``` method DOESN'T calculate length for streams, use ```knownLength``` options as workaround.
348
- - ```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```).
349
- - ```submit``` will not add `content-length` if form length is unknown or not calculable.
350
- - Starting version `2.x` FormData has dropped support for `node@0.10.x`.
351
- - Starting version `3.x` FormData has dropped support for `node@4.x`.
352
-
353
- ## License
354
-
355
- Form-Data is released under the [MIT](License) license.