Skip to content
resolve function which support the browser field in package.json
Latest commit a238dd1 @defunctzombie 1.11.1

browser-resolve Build Status

node.js resolve algorithm with browser field support.


resolve(id, opts={}, cb)

Resolve a module path and call cb(err, path [, pkg])


  • filename - the calling filename where the require() call originated (in the source)
  • paths - require.paths array to use if nothing is found on the normal node_modules recursive walk
  • packageFilter - transform the parsed package.json contents before looking at the main field
  • modules - object with module id/name -> path mappings to consult before doing manual resolution (use to provide core modules)
  • browser - the 'browser' property to use from package.json (defaults to 'browser')

resolve.sync(id, opts={})

Same as the async resolve, just uses sync methods.

basic usage

you can resolve files like require.resolve():

var resolve = require('browser-resolve');
resolve('../', { filename: __filename }, function(err, path) {
$ node example/resolve.js

core modules

By default, core modules (http, dgram, etc) will return their same name as the path. If you want to have specific paths returned, specify a modules property in the options object.

var shims = {
    http: '/your/path/to/http.js'

var resolve = require('browser-resolve');
resolve('fs', { modules: shims }, function(err, path) {
$ node example/builtin.js

browser field

browser-specific versions of modules

  "name": "custom",
  "version": "0.0.0",
  "browser": {
    "./main.js": "custom.js"
  "chromeapp": {
    "./main.js": "custom-chromeapp.js"
var resolve = require('browser-resolve');
var parent = { filename: __dirname + '/custom/file.js' /*, browser: 'chromeapp' */ };
resolve('./main.js', parent, function(err, path) {
$ node example/custom.js


You can skip over dependencies by setting a browser field value to false:

  "name": "skip",
  "version": "0.0.0",
  "browser": {
    "tar": false

This is handy if you have code like:

var tar = require('tar');

exports.add = function (a, b) {
    return a + b;

exports.parse = function () {
    return tar.Parse();

so that require('tar') will just return {} in the browser because you don't intend to support the .parse() export in a browser environment.

var resolve = require('browser-resolve');
var parent = { filename: __dirname + '/skip/main.js' };
resolve('tar', parent, function(err, path) {
$ node example/skip.js



upgrade notes

Prior to v1.x this library provided shims for node core modules. These have since been removed. If you want to have alternative core modules provided, use the modules option when calling resolve.

This was done to allow package managers to choose which shims they want to use without browser-resolve being the central point of update.

Something went wrong with that request. Please try again.