diff options
Diffstat (limited to 'node_modules/resolve-from/readme.md')
| -rw-r--r-- | node_modules/resolve-from/readme.md | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/node_modules/resolve-from/readme.md b/node_modules/resolve-from/readme.md index bb4ca91e8..02e6475d7 100644 --- a/node_modules/resolve-from/readme.md +++ b/node_modules/resolve-from/readme.md @@ -1,8 +1,6 @@ # resolve-from [](https://travis-ci.org/sindresorhus/resolve-from) -> Resolve the path of a module like [`require.resolve()`](http://nodejs.org/api/globals.html#globals_require_resolve) but from a given path - -Unlike `require.resolve()` it returns `null` instead of throwing when the module can't be found. +> Resolve the path of a module like [`require.resolve()`](https://nodejs.org/api/globals.html#globals_require_resolve) but from a given path ## Install @@ -17,7 +15,7 @@ $ npm install --save resolve-from ```js const resolveFrom = require('resolve-from'); -// there's a file at `./foo/bar.js` +// There is a file at `./foo/bar.js` resolveFrom('foo', './bar'); //=> '/Users/sindresorhus/dev/test/foo/bar.js' @@ -28,6 +26,12 @@ resolveFrom('foo', './bar'); ### resolveFrom(fromDir, moduleId) +Like `require()`, throws when the module can't be found. + +### resolveFrom.silent(fromDir, moduleId) + +Returns `null` instead of throwing when the module can't be found. + #### fromDir Type: `string` @@ -43,7 +47,7 @@ What you would use in `require()`. ## Tip -Create a partial using a bound function if you want to require from the same `fromDir` multiple times: +Create a partial using a bound function if you want to resolve from the same `fromDir` multiple times: ```js const resolveFromFoo = resolveFrom.bind(null, 'foo'); @@ -53,6 +57,15 @@ resolveFromFoo('./baz'); ``` +## Related + +- [resolve-cwd](https://github.com/sindresorhus/resolve-cwd) - Resolve the path of a module from the current working directory +- [req-from](https://github.com/sindresorhus/req-from) - Require a module from a given path +- [req-cwd](https://github.com/sindresorhus/req-cwd) - Require a module from the current working directory +- [resolve-pkg](https://github.com/sindresorhus/resolve-pkg) - Resolve the path of a package regardless of it having an entry point +- [lazy-req](https://github.com/sindresorhus/lazy-req) - Require modules lazily + + ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT © [Sindre Sorhus](https://sindresorhus.com) |