# browser-resolve

> resolve which handles browser field support in package.json

Latest version **2.0.0** (published 2020-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install browser-resolve
pnpm add browser-resolve
yarn add browser-resolve
bun add browser-resolve
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-08-03 |
| First published | 2013-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/browser-resolve) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 15.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 100 |
| Author | Roman Shtylman |
| Maintainers | ahdinosaur, anandthakker, ashaffer88, balupton, bpostlethwaite, bret, cwmma, defunctzombie, dominictarr, elnounch, emilbayes, feross, forbeslindesay, fpereira1, garann, gkatsev, goto-bus-stop, hughsk, indutny, jmm, jprichardson, jryans, leichtgewicht, lukechilds, mafintosh, mattdesl, maxogden, mellowmelon, parshap, pkrumins, sethvincent, stevemao, substack, tehshrike, terinjokes, thlorenz, ungoldman, yerkopalma, yoshuawuyts, zertosh |
| Keywords | resolve, browser |

## Links

- npm: https://www.npmjs.com/package/browser-resolve
- Repository: https://github.com/browserify/browser-resolve
- Homepage: https://github.com/browserify/browser-resolve#readme
- Issues: https://github.com/browserify/browser-resolve/issues
- npm.io page: https://npm.io/package/browser-resolve

## Dependencies (1)

- [resolve](https://npm.io/package/resolve.md) ^1.17.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2020-08-03
- 1.11.3 — 2018-06-19
- 1.11.2 — 2016-05-25
- 1.11.1 — 2016-01-25
- 1.11.0 — 2015-12-06
- 1.10.1 — 2015-10-22
- 1.10.0 — 2015-10-15
- 1.9.1 — 2015-08-06
- 1.9.0 — 2015-05-14
- 1.8.2 — 2015-03-28
- 1.8.1 — 2015-03-17
- 1.8.0 — 2015-03-09
- 1.7.2 — 2015-02-21
- 1.7.1 — 2015-02-21
- 1.7.0 — 2015-02-08
- … 27 more at https://npm.io/package/browser-resolve/versions

## README

# browser-resolve [![Build Status](https://travis-ci.org/browserify/browser-resolve.png?branch=master)](https://travis-ci.org/browserify/browser-resolve)

node.js resolve algorithm with [browser field](https://github.com/defunctzombie/package-browser-field-spec) support.

## api

### bresolve(id, opts={}, cb)

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

Options:

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

Additionally, options supported by [node-resolve](https://github.com/browserify/resolve#resolveid-opts-cb) can be used.

### bresolve.sync(id, opts={})

Same as the async resolve, just uses sync methods.

Additionally, options supported by [node-resolve](https://github.com/browserify/resolve#resolvesyncid-opts-cb) can be used.

## basic usage

you can resolve files like `require.resolve()`:
``` js
var bresolve = require('browser-resolve');
bresolve('../', { filename: __filename }, function(err, path) {
    console.log(path);
});
```

```
$ node example/resolve.js
/home/substack/projects/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 bresolve = require('browser-resolve');
bresolve('http', { modules: shims }, function(err, path) {
    console.log(path);
});
```

```
$ node example/builtin.js
/home/substack/projects/browser-resolve/builtin/http.js
```

## browser field
browser-specific versions of modules

``` json
{
  "name": "custom",
  "version": "0.0.0",
  "browser": {
    "./main.js": "custom.js"
  }
}
```

``` js
var bresolve = require('browser-resolve');
var parent = { filename: __dirname + '/custom/file.js' };
bresolve('./main.js', parent, function(err, path) {
    console.log(path);
});
```

```
$ node example/custom.js
/home/substack/projects/browser-resolve/example/custom/custom.js
```

You can use different package.json properties for the resolution, if you want to allow packages to target different environments for example:

``` json
{
  "browser": { "./main.js": "custom.js" },
  "chromeapp": { "./main.js": "custom-chromeapp.js" }
}
```

``` js
var bresolve = require('browser-resolve');
var parent = { filename: __dirname + '/custom/file.js', browser: 'chromeapp' };
bresolve('./main.js', parent, function(err, path) {
    console.log(path);
});
```

```
$ node example/custom.js
/home/substack/projects/browser-resolve/example/custom/custom-chromeapp.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 bresolve = require('browser-resolve');
var parent = { filename: __dirname + '/skip/main.js' };
bresolve('tar', parent, function(err, path) {
    console.log(path);
});
```

```
$ node example/skip.js
/home/substack/projects/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 `bresolve()`.

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

---
_Source: https://npm.io/package/browser-resolve · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._