browser-resolve-noio

    1.4.1 • Public • Published

    browser-resolve-noio Build Status

    This is an experimental fork of browser-resolve, that accepts hooks for readFile and isFile, preventing the module from accessing the disk directly.

    node.js resolve algorithm with browser field support.

    api

    resolve(pkg, opts={}, cb)

    Resolve a module path and call cb(err, path)

    Options:

    • 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)

    resolve.sync(pkg, 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) {
        console.log(path);
    });
    $ node example/resolve.js
    /home/substack/projects/node-browser-resolve/index.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) {
        console.log(path);
    });
    $ node example/builtin.js
    /home/substack/projects/node-browser-resolve/builtin/fs.js
    

    browser field

    browser-specific versions of modules

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

    skip

    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) {
        console.log(path);
    });
    $ node example/skip.js
    /home/substack/projects/node-browser-resolve/empty.js
    

    license

    MIT

    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.

    Install

    npm i browser-resolve-noio

    DownloadsWeekly Downloads

    1

    Version

    1.4.1

    License

    MIT

    Last publish

    Collaborators

    • callumlocke