/usr/share/doc/node-browser-resolve/README.md is in node-browser-resolve 1.11.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | # browser-resolve [](https://travis-ci.org/defunctzombie/node-browser-resolve)
node.js resolve algorithm with [browser](https://gist.github.com/defunctzombie/4339901) field support.
## api
### resolve(id, opts={}, cb)
Resolve a module path and call `cb(err, path [, pkg])`
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)
* `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()`:
``` js
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.
``` js
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
``` js
{
"name": "custom",
"version": "0.0.0",
"browser": {
"./main.js": "custom.js"
},
"chromeapp": {
"./main.js": "custom-chromeapp.js"
}
}
```
``` js
var resolve = require('browser-resolve');
var parent = { filename: __dirname + '/custom/file.js' /*, browser: 'chromeapp' */ };
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](https://gist.github.com/defunctzombie/4339901)
value to `false`:
``` json
{
"name": "skip",
"version": "0.0.0",
"browser": {
"tar": false
}
}
```
This is handy if you have code like:
``` js
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.
``` js
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.
|