1.0.0 • Published 9 years ago

skip-map v1.0.0

Weekly downloads
80
License
MIT
Repository
github
Last release
9 years ago

Skip Map

npm npm GitHub license

Most developer tools built into browsers will automatically request a sourcemap file for .js and .css files that have been minified. In order prevent 404 errors showing in your express application constantly for missing .map files, use this middleware to skip HTTP requests for .map files. Don't use this module if you actually have sourcemap files for your minified files. Adding this to our applications was much easier than constantly reminding developers to turn off sourcemaps in their developer tools.

Install

Using npm:

npm install skip-map --save

Usage

Skip Map middleware must be called before any static middleware.

var express = require('express'),
    skipMap = require('skip-map'),
    app = express();

app.use(skipMap());

app.use(express.static('./public'));

app.listen(3000, function() {
    console.log('Server is listening on port 3000');
});

skipMap(callback)

Returns the skip map middleware function for Express. Takes an optional callback to define how requests for .map files should be handled. When a callback function is not provided, it will just end the request by calling res.send('').

Required?ArgumentTypeDescription
NocallbackFunctionA callback function to define how to handle requests for .map files. Function is called with req, res and next.

Example:

// Without a callback function
app.use(skipMap());

// With a callback function
app.use(skipMap(function(req, res, next) {
    console.log('Skipping request for a .map file');
    res.send('');
}));

// Skip only in Development
app.use(skipMap(function(req, res, next) {
    if(process.env.NODE_ENV === 'development') {
        console.log('Skipping request for a .map file');
        res.send('');
    } else {
        next(); // will try to load the .map file if exists
    }
}));

Issues

Found a bug? Have an enhancement? Create a new issue. I will try to get it fixed as soon as possible.

Contributing

Want to contribute to the project? Fork and submit a pull request.

License

Licensed under the MIT license. See LICENSE in the repository for more information.