1. module form-data
   1. function form-data ()
   2. function form-data.super_ ()
   3. object form-data.super_.prototype
   4. string form-data.DEFAULT_CONTENT_TYPE
   5. string form-data.LINE_BREAK
2. module form-data.super_
   1. function form-data.super_ ()
   2. function form-data.super_.create (options)
   3. function form-data.super_.isStreamLike (stream)
3. module form-data.super_.prototype
   1. function form-data.super_.prototype._checkDataSize ()
   2. function form-data.super_.prototype._emitError (err)
   3. function form-data.super_.prototype._getNext ()
   4. function form-data.super_.prototype._handleErrors (stream)
   5. function form-data.super_.prototype._pipeNext (stream)
   6. function form-data.super_.prototype._reset ()
   7. function form-data.super_.prototype._updateDataSize ()
   8. function form-data.super_.prototype.append (stream)
   9. function form-data.super_.prototype.destroy ()
   10. function form-data.super_.prototype.end ()
   11. function form-data.super_.prototype.pause ()
   12. function form-data.super_.prototype.pipe (dest, options)
   13. function form-data.super_.prototype.resume ()
   14. function form-data.super_.prototype.write (data)

module form-data

function form-data ()

• description and source-code

  function FormData() {
    if (!(this instanceof FormData)) {
      return new FormData();
    }
  
    this._overheadLength = 0;
    this._valueLength = 0;
    this._valuesToMeasure = [];
  
    CombinedStream.call(this);
  }

• example usage

  n/a

function form-data.super_ ()

• description and source-code

  function CombinedStream() {
    this.writable = false;
    this.readable = true;
    this.dataSize = 0;
    this.maxDataSize = 2 * 1024 * 1024;
    this.pauseStreams = true;
  
    this._released = false;
    this._streams = [];
    this._currentStream = null;
  }

• example usage

  n/a

module form-data.super_

function form-data.super_ ()

• description and source-code

  function Stream() {
    EE.call(this);
  }

• example usage

  n/a

function form-data.super_.create (options)

• description and source-code

  create = function (options) {
    var combinedStream = new this();
  
    options = options || {};
    for (var option in options) {
      combinedStream[option] = options[option];
    }
  
    return combinedStream;
  }

• example usage

  n/a

function form-data.super_.isStreamLike (stream)

• description and source-code

  isStreamLike = function (stream) {
    return (typeof stream !== 'function')
      && (typeof stream !== 'string')
      && (typeof stream !== 'boolean')
      && (typeof stream !== 'number')
      && (!Buffer.isBuffer(stream));
  }

• example usage

  n/a

module form-data.super_.prototype

function form-data.super_.prototype._checkDataSize ()

• description and source-code

  _checkDataSize = function () {
    this._updateDataSize();
    if (this.dataSize <= this.maxDataSize) {
      return;
    }
  
    var message =
      'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.';
    this._emitError(new Error(message));
  }

• example usage

  n/a

function form-data.super_.prototype._emitError (err)

• description and source-code

  _emitError = function (err) {
    this._reset();
    this.emit('error', err);
  }

• example usage

  n/a

function form-data.super_.prototype._getNext ()

• description and source-code

  _getNext = function () {
    this._currentStream = null;
    var stream = this._streams.shift();
  
  
    if (typeof stream == 'undefined') {
      this.end();
      return;
    }
  
    if (typeof stream !== 'function') {
      this._pipeNext(stream);
      return;
    }
  
    var getStream = stream;
    getStream(function(stream) {
      var isStreamLike = CombinedStream.isStreamLike(stream);
      if (isStreamLike) {
        stream.on('data', this._checkDataSize.bind(this));
        this._handleErrors(stream);
      }
  
      this._pipeNext(stream);
    }.bind(this));
  }

• example usage

  n/a

function form-data.super_.prototype._handleErrors (stream)

• description and source-code

  _handleErrors = function (stream) {
    var self = this;
    stream.on('error', function(err) {
      self._emitError(err);
    });
  }

• example usage

  n/a

function form-data.super_.prototype._pipeNext (stream)

• description and source-code

  _pipeNext = function (stream) {
    this._currentStream = stream;
  
    var isStreamLike = CombinedStream.isStreamLike(stream);
    if (isStreamLike) {
      stream.on('end', this._getNext.bind(this));
      stream.pipe(this, {end: false});
      return;
    }
  
    var value = stream;
    this.write(value);
    this._getNext();
  }

• example usage

  n/a

function form-data.super_.prototype._reset ()

• description and source-code

  _reset = function () {
    this.writable = false;
    this._streams = [];
    this._currentStream = null;
  }

• example usage

  n/a

function form-data.super_.prototype._updateDataSize ()

• description and source-code

  _updateDataSize = function () {
    this.dataSize = 0;
  
    var self = this;
    this._streams.forEach(function(stream) {
      if (!stream.dataSize) {
        return;
      }
  
      self.dataSize += stream.dataSize;
    });
  
    if (this._currentStream && this._currentStream.dataSize) {
      this.dataSize += this._currentStream.dataSize;
    }
  }

• example usage

  n/a

function form-data.super_.prototype.append (stream)

• description and source-code

  append = function (stream) {
    var isStreamLike = CombinedStream.isStreamLike(stream);
  
    if (isStreamLike) {
      if (!(stream instanceof DelayedStream)) {
        var newStream = DelayedStream.create(stream, {
          maxDataSize: Infinity,
          pauseStream: this.pauseStreams,
        });
        stream.on('data', this._checkDataSize.bind(this));
        stream = newStream;
      }
  
      this._handleErrors(stream);
  
      if (this.pauseStreams) {
        stream.pause();
      }
    }
  
    this._streams.push(stream);
    return this;
  }

• example usage

  ...
  a buffer and a file stream.
  
  ``` javascript
  var FormData = require('form-data');
  var fs = require('fs');
  
  var form = new FormData();
  form.append('my_field', 'my value');
  form.append('my_buffer', new Buffer(10));
  form.append('my_file', fs.createReadStream('/foo/bar.jpg'));
  ```
  
  Also you can use http-response stream:
  
  ``` javascript
  ...

function form-data.super_.prototype.destroy ()

• description and source-code

  destroy = function () {
    this._reset();
    this.emit('close');
  }

• example usage

  n/a

function form-data.super_.prototype.end ()

• description and source-code

  end = function () {
    this._reset();
    this.emit('end');
  }

• example usage

  n/a

function form-data.super_.prototype.pause ()

• description and source-code

  pause = function () {
    if (!this.pauseStreams) {
      return;
    }
  
    if(this.pauseStreams && this._currentStream && typeof(this._currentStream.pause) == 'function') this._currentStream.pause();
    this.emit('pause');
  }

• example usage

  ...
  } else if (value.hasOwnProperty('httpVersion')) {
    callback(null, +value.headers['content-length']);
  
  // or request stream http://github.com/mikeal/request
  } else if (value.hasOwnProperty('httpModule')) {
    // wait till response come back
    value.on('response', function(response) {
      value.pause();
      callback(null, +response.headers['content-length']);
    });
    value.resume();
  
  // something else
  } else {
    callback('Unknown stream');
  ...

function form-data.super_.prototype.pipe (dest, options)

• description and source-code

  pipe = function (dest, options) {
    Stream.prototype.pipe.call(this, dest, options);
    this.resume();
    return dest;
  }

• example usage

  ...
  var request = http.request({
    method: 'post',
    host: 'example.org',
    path: '/upload',
    headers: form.getHeaders()
  });
  
  form.pipe(request);
  
  request.on('response', function(res) {
    console.log(res.statusCode);
  });
  ```
  
  Or if you would prefer the `'Content-Length'` header to be set for you:
  ...

function form-data.super_.prototype.resume ()

• description and source-code

  resume = function () {
    if (!this._released) {
      this._released = true;
      this.writable = true;
      this._getNext();
    }
  
    if(this.pauseStreams && this._currentStream && typeof(this._currentStream.resume) == 'function') this._currentStream.resume();
    this.emit('resume');
  }

• example usage

  ...
  ```
  
  In order to submit this form to a web application, call ```submit(url, [callback])``` method:
  
  ``` javascript
  form.submit('http://example.org/', function(err, res) {
    // res – response object (http.IncomingMessage)  //
    res.resume();
  });
  
  ```
  
  For more advanced request manipulations ```submit()``` method returns ```http.ClientRequest``` object, or you can choose from one
   of the alternative submission methods.
  
  ### Alternative submission methods
  ...

function form-data.super_.prototype.write (data)

• description and source-code

  write = function (data) {
    this.emit('data', data);
  }

• example usage

  n/a