diff options
Diffstat (limited to 'node_modules/resolve-cwd/readme.md')
| -rw-r--r-- | node_modules/resolve-cwd/readme.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/node_modules/resolve-cwd/readme.md b/node_modules/resolve-cwd/readme.md new file mode 100644 index 0000000..d9f3129 --- /dev/null +++ b/node_modules/resolve-cwd/readme.md @@ -0,0 +1,58 @@ +# resolve-cwd [](https://travis-ci.org/sindresorhus/resolve-cwd) + +> Resolve the path of a module like [`require.resolve()`](https://nodejs.org/api/globals.html#globals_require_resolve) but from the current working directory + + +## Install + +``` +$ npm install resolve-cwd +``` + + +## Usage + +```js +const resolveCwd = require('resolve-cwd'); + +console.log(__dirname); +//=> '/Users/sindresorhus/rainbow' + +console.log(process.cwd()); +//=> '/Users/sindresorhus/unicorn' + +console.log(resolveCwd('./foo')); +//=> '/Users/sindresorhus/unicorn/foo.js' +``` + + +## API + +### resolveCwd(moduleId) + +Like `require()`, throws when the module can't be found. + +### resolveCwd.silent(moduleId) + +Returns `undefined` instead of throwing when the module can't be found. + +#### moduleId + +Type: `string` + +What you would use in `require()`. + + +## Related + +- [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module from a given path +- [import-from](https://github.com/sindresorhus/import-from) - Import a module from a given path +- [import-cwd](https://github.com/sindresorhus/import-cwd) - Import 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 +- [import-lazy](https://github.com/sindresorhus/import-lazy) - Import a module lazily +- [resolve-global](https://github.com/sindresorhus/resolve-global) - Resolve the path of a globally installed module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |