1. module mime-types
   1. function mime-types.charset (type)
   2. function mime-types.contentType (str)
   3. function mime-types.extension (type)
   4. function mime-types.lookup (path)
   5. object mime-types.charsets
   6. object mime-types.extensions
   7. object mime-types.index
   8. object mime-types.types
2. module mime-types.charsets
   1. function mime-types.charsets.lookup (type)
3. module mime-types.index
   1. function mime-types.index.charset (type)
   2. function mime-types.index.contentType (str)
   3. function mime-types.index.extension (type)
   4. function mime-types.index.lookup (path)
   5. object mime-types.index.charsets
   6. object mime-types.index.extensions
   7. object mime-types.index.types

module mime-types

function mime-types.charset (type)

• description and source-code

  function charset(type) {
    if (!type || typeof type !== 'string') {
      return false
    }
  
    // TODO: use media-typer
    var match = extractTypeRegExp.exec(type)
    var mime = match && db[match[1].toLowerCase()]
  
    if (mime && mime.charset) {
      return mime.charset
    }
  
    // default text/* to utf-8
    if (match && textTypeRegExp.test(match[1])) {
      return 'UTF-8'
    }
  
    return false
  }

• example usage

  ...
  
  Get the default extension for a content-type.
  
  ```js
  mime.extension('application/octet-stream') // 'bin'
  ```
  
  ### mime.charset(type)
  
  Lookup the implied default charset of a content-type.
  
  ```js
  mime.charset('text/x-markdown') // 'UTF-8'
  ```
  ...

function mime-types.contentType (str)

• description and source-code

  function contentType(str) {
    // TODO: should this even be in this module?
    if (!str || typeof str !== 'string') {
      return false
    }
  
    var mime = str.indexOf('/') === -1
      ? exports.lookup(str)
      : str
  
    if (!mime) {
      return false
    }
  
    // TODO: use content-type or other module
    if (mime.indexOf('charset') === -1) {
      var charset = exports.charset(mime)
      if (charset) mime += '; charset=' + charset.toLowerCase()
    }
  
    return mime
  }

• example usage

  ...
  mime.lookup('file.html')        // 'text/html'
  mime.lookup('folder/file.js')   // 'application/javascript'
  mime.lookup('folder/.htaccess') // false
  
  mime.lookup('cats') // false
  ```
  
  ### mime.contentType(type)
  
  Create a full content-type header given a content-type or extension.
  
  ```js
  mime.contentType('markdown')  // 'text/x-markdown; charset=utf-8'
  mime.contentType('file.json') // 'application/json; charset=utf-8'
  ...

function mime-types.extension (type)

• description and source-code

  function extension(type) {
    if (!type || typeof type !== 'string') {
      return false
    }
  
    // TODO: use media-typer
    var match = extractTypeRegExp.exec(type)
  
    // get extensions
    var exts = match && exports.extensions[match[1].toLowerCase()]
  
    if (!exts || !exts.length) {
      return false
    }
  
    return exts[0]
  }

• example usage

  ...
  mime.contentType('markdown')  // 'text/x-markdown; charset=utf-8'
  mime.contentType('file.json') // 'application/json; charset=utf-8'
  
  // from a full path
  mime.contentType(path.extname('/path/to/file.json')) // 'application/json; charset=utf-8'
  ```
  
  ### mime.extension(type)
  
  Get the default extension for a content-type.
  
  ```js
  mime.extension('application/octet-stream') // 'bin'
  ```
  ...

function mime-types.lookup (path)

• description and source-code

  function lookup(path) {
    if (!path || typeof path !== 'string') {
      return false
    }
  
    // get the extension ("ext" or ".ext" or full path)
    var extension = extname('x.' + path)
      .toLowerCase()
      .substr(1)
  
    if (!extension) {
      return false
    }
  
    return exports.types[extension] || false
  }

• example usage

  ...
  
  The ultimate javascript content-type utility.
  
  Similar to [the `mime` module](https://www.npmjs.com/package/mime), except:
  
  - __No fallbacks.__ Instead of naively returning the first available type,
    `mime-types` simply returns `false`, so do
    `var type = mime.lookup('unrecognized') || 'application/octet-stream
  '`.
  - No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
  - No `.define()` functionality
  - Bug fixes for `.lookup(path)`
  
  Otherwise, the API is compatible.
  
  ## Install
  ...

module mime-types.charsets

function mime-types.charsets.lookup (type)

• description and source-code

  function charset(type) {
    if (!type || typeof type !== 'string') {
      return false
    }
  
    // TODO: use media-typer
    var match = extractTypeRegExp.exec(type)
    var mime = match && db[match[1].toLowerCase()]
  
    if (mime && mime.charset) {
      return mime.charset
    }
  
    // default text/* to utf-8
    if (match && textTypeRegExp.test(match[1])) {
      return 'UTF-8'
    }
  
    return false
  }

• example usage

  ...
  
  The ultimate javascript content-type utility.
  
  Similar to [the `mime` module](https://www.npmjs.com/package/mime), except:
  
  - __No fallbacks.__ Instead of naively returning the first available type,
    `mime-types` simply returns `false`, so do
    `var type = mime.lookup('unrecognized') || 'application/octet-stream
  '`.
  - No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
  - No `.define()` functionality
  - Bug fixes for `.lookup(path)`
  
  Otherwise, the API is compatible.
  
  ## Install
  ...

module mime-types.index

function mime-types.index.charset (type)

• description and source-code

  function charset(type) {
    if (!type || typeof type !== 'string') {
      return false
    }
  
    // TODO: use media-typer
    var match = extractTypeRegExp.exec(type)
    var mime = match && db[match[1].toLowerCase()]
  
    if (mime && mime.charset) {
      return mime.charset
    }
  
    // default text/* to utf-8
    if (match && textTypeRegExp.test(match[1])) {
      return 'UTF-8'
    }
  
    return false
  }

• example usage

  ...
  
  Get the default extension for a content-type.
  
  ```js
  mime.extension('application/octet-stream') // 'bin'
  ```
  
  ### mime.charset(type)
  
  Lookup the implied default charset of a content-type.
  
  ```js
  mime.charset('text/x-markdown') // 'UTF-8'
  ```
  ...

function mime-types.index.contentType (str)

• description and source-code

  function contentType(str) {
    // TODO: should this even be in this module?
    if (!str || typeof str !== 'string') {
      return false
    }
  
    var mime = str.indexOf('/') === -1
      ? exports.lookup(str)
      : str
  
    if (!mime) {
      return false
    }
  
    // TODO: use content-type or other module
    if (mime.indexOf('charset') === -1) {
      var charset = exports.charset(mime)
      if (charset) mime += '; charset=' + charset.toLowerCase()
    }
  
    return mime
  }

• example usage

  ...
  mime.lookup('file.html')        // 'text/html'
  mime.lookup('folder/file.js')   // 'application/javascript'
  mime.lookup('folder/.htaccess') // false
  
  mime.lookup('cats') // false
  ```
  
  ### mime.contentType(type)
  
  Create a full content-type header given a content-type or extension.
  
  ```js
  mime.contentType('markdown')  // 'text/x-markdown; charset=utf-8'
  mime.contentType('file.json') // 'application/json; charset=utf-8'
  ...

function mime-types.index.extension (type)

• description and source-code

  function extension(type) {
    if (!type || typeof type !== 'string') {
      return false
    }
  
    // TODO: use media-typer
    var match = extractTypeRegExp.exec(type)
  
    // get extensions
    var exts = match && exports.extensions[match[1].toLowerCase()]
  
    if (!exts || !exts.length) {
      return false
    }
  
    return exts[0]
  }

• example usage

  ...
  mime.contentType('markdown')  // 'text/x-markdown; charset=utf-8'
  mime.contentType('file.json') // 'application/json; charset=utf-8'
  
  // from a full path
  mime.contentType(path.extname('/path/to/file.json')) // 'application/json; charset=utf-8'
  ```
  
  ### mime.extension(type)
  
  Get the default extension for a content-type.
  
  ```js
  mime.extension('application/octet-stream') // 'bin'
  ```
  ...

function mime-types.index.lookup (path)

• description and source-code

  function lookup(path) {
    if (!path || typeof path !== 'string') {
      return false
    }
  
    // get the extension ("ext" or ".ext" or full path)
    var extension = extname('x.' + path)
      .toLowerCase()
      .substr(1)
  
    if (!extension) {
      return false
    }
  
    return exports.types[extension] || false
  }

• example usage

  ...
  
  The ultimate javascript content-type utility.
  
  Similar to [the `mime` module](https://www.npmjs.com/package/mime), except:
  
  - __No fallbacks.__ Instead of naively returning the first available type,
    `mime-types` simply returns `false`, so do
    `var type = mime.lookup('unrecognized') || 'application/octet-stream
  '`.
  - No `new Mime()` business, so you could do `var lookup = require('mime-types').lookup`.
  - No `.define()` functionality
  - Bug fixes for `.lookup(path)`
  
  Otherwise, the API is compatible.
  
  ## Install
  ...