node package manager

mime-types

mime-types

NPM Version NPM Downloads Node.js Version Build Status Test Coverage

The ultimate javascript content-type utility.

Similar to the mime module, 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

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install mime-types

Adding Types

All mime types are based on mime-db, so open a PR there if you'd like to add mime types.

API

var mime = require('mime-types')

All functions return false if input is invalid or not found.

mime.lookup(path)

Lookup the content-type associated with a file.

mime.lookup('json')             // 'application/json' 
mime.lookup('.md')              // 'text/x-markdown' 
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.

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.

mime.extension('application/octet-stream') // 'bin' 

mime.charset(type)

Lookup the implied default charset of a content-type.

mime.charset('text/x-markdown') // 'UTF-8' 

var type = mime.types[extension]

A map of content-types by extension.

[extensions...] = mime.extensions[type]

A map of extensions by content-type.

License

MIT