An open API service indexing awesome lists of open source software.

https://github.com/seebigs/seebigs-resolve


https://github.com/seebigs/seebigs-resolve

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# seebigs-resolve

Resolve a target string to a single filepath and get the contents of the file at that location

*Follows Node spec: [https://nodejs.org/api/modules.html](https://nodejs.org/api/modules.html)*

## Install

```
$ npm install seebigs-resolve
```

## Resolve

```js
var resolve = require('seebigs-resolve');
var fromFile = __filename;

resolve('/abs/module.js', fromFile);
resolve('../rel/module.js', fromFile);
resolve('npm_module', fromFile);

// returns { contents: '...', path: '/path/to/module.js' }
```

## Paths

Modules can also be resolved from an optional array of paths

```js
var resolve = require('seebigs-resolve');
var fromFile = __filename;
var paths = [
'../one'
];

resolve('module.js', fromFile, paths);
```

## Browser Field

Force resolve to use the browser field in package.json

```js
var resolve = require('seebigs-resolve');
var fromFile = __filename;

resolve.browser('module.js', fromFile);
```