resolve/README.markdown

A more hookable require.resolve() implementation

resolve
=======

Implements the [node `require.resolve()`
algorithm](http://nodejs.org/docs/v0.4.8/api/all.html#all_Together...)
except you can pass in the file to compute paths relatively to along with your
own `require.paths` without updating the global copy (which doesn't even work in
node `>=0.5`).

[![build status](https://secure.travis-ci.org/substack/node-resolve.png)](http://travis-ci.org/substack/node-resolve)

methods
=======

var resolve = require('resolve');

resolve.sync(pkg, opts)
-----------------------

Synchronously search for the package/filename string `pkg`
according to the [`require.resolve()`
algorithm](http://nodejs.org/docs/v0.4.8/api/all.html#all_Together...)
for `X=pkg` and `Y=opts.basedir`.

Default values for `opts`:

````javascript
{
    paths : [],
    basedir : __dirname,
    extensions : [ '.js' ],
    readFileSync : fs.readFileSync,
    isFile : function (file) {
        return path.existSync(file) && fs.statSync(file).isFile()
    }
}
````

Optionally you can specify a `opts.packageFilter` function to map the contents
of `JSON.parse()`'d package.json files.

If nothing is found, all of the directories in `opts.paths` are searched.

resolve.isCore(pkg)
-------------------

Return whether a package is in core.