formstream 1.1.1 → 1.3.0

package/README.md

@@ -1,19 +1,13 @@
 # formstream
 
 [![NPM version][npm-image]][npm-url]
-[![build status][travis-image]][travis-url]
 [![Test coverage][coveralls-image]][coveralls-url]
-[![David deps][david-image]][david-url]
 [![npm download][download-image]][download-url]
 
 [npm-image]: https://img.shields.io/npm/v/formstream.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/formstream
-[travis-image]: https://img.shields.io/travis/node-modules/formstream.svg?style=flat-square
-[travis-url]: https://travis-ci.org/node-modules/formstream
 [coveralls-image]: https://img.shields.io/coveralls/node-modules/formstream.svg?style=flat-square
 [coveralls-url]: https://coveralls.io/r/node-modules/formstream?branch=master
-[david-image]: https://img.shields.io/david/node-modules/formstream.svg?style=flat-square
-[david-url]: https://david-dm.org/node-modules/formstream
 [download-image]: https://img.shields.io/npm/dm/formstream.svg?style=flat-square
 [download-url]: https://npmjs.org/package/formstream
 

package/lib/formstream.js

@@ -33,7 +33,7 @@ var destroy = require('destroy');
 
 var PADDING = '--';
 var NEW_LINE = '\r\n';
-var NEW_LINE_BUFFER = new Buffer(NEW_LINE);
+var NEW_LINE_BUFFER =  Buffer.from(NEW_LINE);
 
 function FormStream() {
   if (!(this instanceof FormStream)) {
@@ -45,7 +45,7 @@ function FormStream() {
   this._boundary = this._generateBoundary();
   this._streams = [];
   this._buffers = [];
-  this._endData = new Buffer(PADDING + this._boundary + PADDING + NEW_LINE);
+  this._endData = Buffer.from(PADDING + this._boundary + PADDING + NEW_LINE);
   this._contentLength = 0;
   this._isAllStreamSizeKnown = true;
   this._knownStreamSize = 0;
@@ -137,7 +137,7 @@ FormStream.prototype.field = function (name, value) {
     if (typeof value === 'number') {
       value = String(value);
     }
-    value = new Buffer(value);
+    value = Buffer.from(value);
   }
   return this.buffer(name, value);
 };
@@ -222,7 +222,7 @@ FormStream.prototype._leading = function (disposition, type) {
   leading.push('');
   leading.push('');
 
-  return new Buffer(leading.join(NEW_LINE));
+  return Buffer.from(leading.join(NEW_LINE));
 };
 
 FormStream.prototype._emitBuffers = function () {

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "formstream",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "A multipart/form-data encoded stream, helper for file upload.",
   "main": "lib/formstream.js",
+  "types": "types/formstream.d.ts",
   "files": [
-    "lib"
+    "lib",
+    "types/formstream.d.ts"
   ],
   "scripts": {
-    "test": "mocha -R spec -t 5000 -r should test/*.test.js",
-    "test-cov": "istanbul cover node_modules/.bin/_mocha -- -t 5000 -r should test/*.test.js",
-    "test-travis": "istanbul cover node_modules/.bin/_mocha --report lcovonly -- -t 5000 -r should test/*.test.js",
-    "jshint": "jshint .",
-    "autod": "autod -w --prefix '^'"
+    "test": "egg-bin test",
+    "cov": "egg-bin cov",
+    "ci": "npm run lint && npm run tsd && npm run cov",
+    "lint": "jshint .",
+    "tsd": "tsd"
   },
   "repository": {
     "type": "git",
@@ -32,15 +34,16 @@
     "pause-stream": "~0.0.11"
   },
   "devDependencies": {
-    "autod": "*",
+    "@types/node": "^20.4.3",
     "connect-multiparty": "1",
+    "egg-bin": "^5.6.1",
     "express": "^4.16.4",
-    "istanbul": "*",
-    "mocha": "3",
+    "jshint": "^2.13.6",
     "pedding": "1",
     "should": "4",
+    "tsd": "^0.28.1",
     "urllib": "2"
   },
-  "author": "fengmk2 <fengmk2@gmail.com> (https://fengmk2.com)",
+  "author": "fengmk2 <fengmk2@gmail.com> (https://github.com/fengmk2)",
   "license": "MIT"
 }

package/types/formstream.d.ts

@@ -0,0 +1,72 @@
+import { Readable, Stream } from 'stream'
+
+declare class FormStream extends Stream {
+  /**
+   * Add a normal field to the form.
+   *
+   * @param name Name of field
+   * @param value Value of field
+   */
+  field(name: string, value: string): this
+
+  /**
+   * Add a local file to be uploaded to the form.
+   *
+   * @param name Name of file field
+   * @param filepath Local path of the file to be uploaded
+   * @param filename Name of the file (will be the base name of filepath if empty)
+   * @param filesize Size of the file (will not generate Content-Length header if not specified)
+   */
+  file(
+    name: string,
+    filepath: string,
+    filename?: string,
+    filesize?: number,
+  ): this
+
+  /**
+   * Add a buffer as a file to upload.
+   *
+   * @param name Name of field
+   * @param buffer The buffer to be uploaded
+   * @param filename The file name that tells the remote server
+   * @param contentType Content-Type (aka. MIME Type) of content (will be infered with filename if empty)
+   */
+  buffer(
+    name: string,
+    buffer: Buffer,
+    filename: string,
+    contentType?: string,
+  ): this
+
+  /**
+   * Add a readable stream as a file to upload. Event 'error' will be emitted if an error occured.
+   *
+   * @param name Name of field
+   * @param stream A readable stream to be piped
+   * @param filename The file name that tells the remote server
+   * @param contentType Content-Type (aka. MIME Type) of content (will be infered with filename if empty)
+   * @param size Size of the stream (will not generate Content-Length header if not specified)
+   */
+  stream(
+    name: string,
+    stream: Readable,
+    filename: string,
+    contentType?: string,
+    size?: number,
+  ): this
+
+  /**
+   * Get headers for the request.
+   *
+   * @param additionalHeaders Additional headers
+   */
+  headers(additionalHeaders?: Record<string, any>): Record<string, any>
+}
+
+declare const formStream: {
+  new (): FormStream
+  (): FormStream
+}
+
+export = formStream

package/History.md

@@ -1,73 +0,0 @@
-
-1.1.1 / 2021-04-28
-==================
-
-**fixes**
-  * [[`c96ba5b`](http://github.com/node-modules/formstream/commit/c96ba5bace0e96bf39770769e43d9de4271971d8)] - fix: upgrade mime to fix wrong mime type (#19) (shaozj <<shaozj@users.noreply.github.com>>)
-
-**others**
-  * [[`21918e5`](http://github.com/node-modules/formstream/commit/21918e5fc37a4cea5aae82659d39587f099e805b)] - chore: upgrade devDeps express to latest version (#15) (fengmk2 <<fengmk2@gmail.com>>)
-
-1.1.0 / 2016-12-19
-==================
-
-  * deps: upgrade mime to latest version (#9)
-
-1.0.0 / 2014-11-04
-==================
-
- * fix(field): support stream.field(String, Number)
- * chore: fix links
- * chore: use npm scripts instead of Makefile
- * fix test case on node@0.8
-
-0.0.8 / 2014-01-17 
-==================
-
-  * destroy source stream when formstream destroy()
-  * add more test cases
-
-0.0.7 / 2013-07-25 
-==================
-
-  * feature: always try to infer `Content-Length` (@xingrz)
-  * doc improve
-
-0.0.6 / 2013-07-15 
-==================
-
-  * added test cases for chaining call (@xingrz)
-  * improved docs (@xingrz)
-  * added chaining support (@xingrz)
-  * api doc
-  * fixed test causes
-  * update dependencies version
-
-0.0.5 / 2012-11-06 
-==================
-
-  * fixed stream error not catch bug
-
-0.0.4 / 2012-11-06 
-==================
-
-  * fixed #2 support form.buffer()
-  * add doc for setTotalStreamSize()
-
-0.0.3 / 2012-11-06 
-==================
-
-  * support content-length use form.setTotalStreamSize(size)
-  * update readme
-
-0.0.2 / 2012-10-11 
-==================
-
-  * use buffer-concat support node < 0.8
-
-0.0.1 / 2012-10-11 
-==================
-
-  * support multi streams.
-  * add one stream support now.
-  * Initial commit