1. module content-disposition
   1. function content-disposition (filename, options)
   2. function content-disposition.parse (string)
   3. function content-disposition.toString ()
2. module content-disposition.parse
   1. function content-disposition.parse (string)
3. module content-disposition.toString
   1. function content-disposition.toString ()

module content-disposition

function content-disposition (filename, options)

• description and source-code

  function contentDisposition(filename, options) {
    var opts = options || {}
  
    // get type
    var type = opts.type || 'attachment'
  
    // get parameters
    var params = createparams(filename, opts.fallback)
  
    // format into string
    return format(new ContentDisposition(type, params))
  }

• example usage

  n/a

function content-disposition.parse (string)

• description and source-code

  function parse(string) {
    if (!string || typeof string !== 'string') {
      throw new TypeError('argument string is required')
    }
  
    var match = DISPOSITION_TYPE_REGEXP.exec(string)
  
    if (!match) {
      throw new TypeError('invalid type format')
    }
  
    // normalize type
    var index = match[0].length
    var type = match[1].toLowerCase()
  
    var key
    var names = []
    var params = {}
    var value
  
    // calculate index to start at
    index = PARAM_REGEXP.lastIndex = match[0].substr(-1) === ';'
      ? index - 1
      : index
  
    // match parameters
    while ((match = PARAM_REGEXP.exec(string))) {
      if (match.index !== index) {
        throw new TypeError('invalid parameter format')
      }
  
      index += match[0].length
      key = match[1].toLowerCase()
      value = match[2]
  
      if (names.indexOf(key) !== -1) {
        throw new TypeError('invalid duplicate parameter')
      }
  
      names.push(key)
  
      if (key.indexOf('*') + 1 === key.length) {
        // decode extended value
        key = key.slice(0, -1)
        value = decodefield(value)
  
        // overwrite existing value
        params[key] = value
        continue
      }
  
      if (typeof params[key] === 'string') {
        continue
      }
  
      if (value[0] === '"') {
        // remove quotes and escapes
        value = value
          .substr(1, value.length - 2)
          .replace(QESC_REGEXP, '$1')
      }
  
      params[key] = value
    }
  
    if (index !== -1 && index !== string.length) {
      throw new TypeError('invalid parameter format')
    }
  
    return new ContentDisposition(type, params)
  }

• example usage

  ...
  ##### type
  
  Specifies the disposition type, defaults to `"attachment"`. This can also be
  `"inline"`, or any other value (all values except inline are treated like
  `attachment`, but can convey additional information if both parties agree to
  it). The type is normalized to lower-case.
  
  ### contentDisposition.parse(string)
  
  ```js
  var disposition = contentDisposition.parse('attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%
  e2%82%ac%20rates.txt');
  ```
  
  Parse a `Content-Disposition` header string. This automatically handles extended
  ("Unicode") parameters by decoding them and providing them under the standard
  ...

function content-disposition.toString ()

• description and source-code

  toString = function () {
      return text;
  }

• example usage

  ...
    var binary = encoded.replace(HEX_ESCAPE_REPLACE_REGEXP, pdecode)
  
    switch (charset) {
      case 'iso-8859-1':
        value = getlatin1(binary)
        break
      case 'utf-8':
        value = new Buffer(binary, 'binary').toString('utf8')
        break
      default:
        throw new TypeError('unsupported charset in extended field')
    }
  
    return value
  }
  ...

module content-disposition.parse

function content-disposition.parse (string)

• description and source-code

  function parse(string) {
    if (!string || typeof string !== 'string') {
      throw new TypeError('argument string is required')
    }
  
    var match = DISPOSITION_TYPE_REGEXP.exec(string)
  
    if (!match) {
      throw new TypeError('invalid type format')
    }
  
    // normalize type
    var index = match[0].length
    var type = match[1].toLowerCase()
  
    var key
    var names = []
    var params = {}
    var value
  
    // calculate index to start at
    index = PARAM_REGEXP.lastIndex = match[0].substr(-1) === ';'
      ? index - 1
      : index
  
    // match parameters
    while ((match = PARAM_REGEXP.exec(string))) {
      if (match.index !== index) {
        throw new TypeError('invalid parameter format')
      }
  
      index += match[0].length
      key = match[1].toLowerCase()
      value = match[2]
  
      if (names.indexOf(key) !== -1) {
        throw new TypeError('invalid duplicate parameter')
      }
  
      names.push(key)
  
      if (key.indexOf('*') + 1 === key.length) {
        // decode extended value
        key = key.slice(0, -1)
        value = decodefield(value)
  
        // overwrite existing value
        params[key] = value
        continue
      }
  
      if (typeof params[key] === 'string') {
        continue
      }
  
      if (value[0] === '"') {
        // remove quotes and escapes
        value = value
          .substr(1, value.length - 2)
          .replace(QESC_REGEXP, '$1')
      }
  
      params[key] = value
    }
  
    if (index !== -1 && index !== string.length) {
      throw new TypeError('invalid parameter format')
    }
  
    return new ContentDisposition(type, params)
  }

• example usage

  ...
  ##### type
  
  Specifies the disposition type, defaults to `"attachment"`. This can also be
  `"inline"`, or any other value (all values except inline are treated like
  `attachment`, but can convey additional information if both parties agree to
  it). The type is normalized to lower-case.
  
  ### contentDisposition.parse(string)
  
  ```js
  var disposition = contentDisposition.parse('attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%
  e2%82%ac%20rates.txt');
  ```
  
  Parse a `Content-Disposition` header string. This automatically handles extended
  ("Unicode") parameters by decoding them and providing them under the standard
  ...

module content-disposition.toString

function content-disposition.toString ()

• description and source-code

  function toString() { [native code] }

• example usage

  ...
    var binary = encoded.replace(HEX_ESCAPE_REPLACE_REGEXP, pdecode)
  
    switch (charset) {
      case 'iso-8859-1':
        value = getlatin1(binary)
        break
      case 'utf-8':
        value = new Buffer(binary, 'binary').toString('utf8')
        break
      default:
        throw new TypeError('unsupported charset in extended field')
    }
  
    return value
  }
  ...