Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Proper MIME type detection library for node.js that wraps the libmagic functionality
JavaScript
tag: v0.4

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
share
tests
tools
vendor
.gitignore
.npmignore
CHANGELOG.md
LICENSE.md
Makefile
README.md
make.js
package.json

README.md

About

MIME type detection library for node.js. Unlike the mime module, mime-magic does not return the type by interpreting the file extension. Instead it uses the libmagic(3) library which provides the result by reading the "magic number" of the file itself.

Currently it provides just a simple file(1) wrapper to get the things moving, but in the long run, the purpose of this module is to provide proper node.js libmagic bindings. The file(1) source tree is provided along with this package. It is built during the installation process. The module aims to use the latest available file version along with the up-to-date magic database.

The Windows version of file(1) is bundled with the package. It is a native binary build with MinGW and compressed with UPX.

Installation

Either manually clone this repository into your node_modules directory, run make build (under unices), or the recommended method:

npm install mime-magic

Usage mode

var mime = require('mime-magic');

mime('/path/to/foo.pdf', function (err, type) {
    if (err) {
        console.error(err.message);
        // ERROR: cannot open `/path/to/foo.pdf' (No such file or directory)
    } else {
        console.log('Detected mime type: %s', type);
        // application/pdf
    }
});

You may use an array of paths. The callback gets an array of mimes:

var files = [
    '/path/to/foo.pdf',
    '/path/to/foo.txt'
];

mime(files, function (err, types) {
    if (err) {
        console.error(err.message);
        // ERROR: cannot open `/path/to/foo.pdf' (No such file or directory)
        // ERROR: cannot open `/path/to/foo.txt' (No such file or directory)
    } else {
        console.log(types);
        // ['application/pdf', 'text/plain']
    }
});

Under Windows, you must escape the backslash separators of the path argument:

mime('C:\\path\\to\\foo.pdf', function (err, type) {
    // do something
});

You may also pass a path that uses forward slashes as separators:

mime('C:/path/to/foo.pdf', function (err, type) {
    // do something
});

Passing relative paths is supported. The file wrapper uses child_process.execFile() behind the scenes, therefore the err argument contains the information returned by the execFile() method itself plus the error message returned by file(1).

Notices

The mime.fileWrapper method is deprecated. The preferred method is to call the module directly.

The module is developed under Ubuntu 12.04, and Windows 7. It is tested under OS X Lion, and FreeBSD 9.0. Other platforms may be supported, but the behavior is untested.

The Windows binaries are built by myself under Windows 7 / MinGW + MSYS. The binaries are packed with the UPX tool in order to make them smaller.

Here's the virustotal.com analysis:

Please notice that some antiviruses may throw false positives.

Contributors

  • Felix Chan - #1: couldn't use fileWrapper more than once unless restarted server.
  • eddyb - #3: support for arrays of paths, with the callback getting an array of mime-types.
Something went wrong with that request. Please try again.