.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / require-relative / README.md
1 # require-relative
2
3 require-relative is a node.js program to require and resolve modules relative to a path of your choice.
4 It exploits node.js's own `module` module, and has no additional dependencies.
5
6 ## Example
7
8 requiring modules relatively
9
10 ```js
11 var relative = require('require-relative');
12
13 var someModule = relative('./some-module', '/home/kamicane');
14 var somePackage = relative('some-package', '/home/kamicane');
15 var isTrue = relative('./some-module.js', process.cwd()) === relative('./some-module.js');
16 ```
17
18 resolving filenames relatively
19
20 ```js
21 var relative = require('require-relative');
22
23 relative.resolve('./some-module', '/home/kamicane'); // /home/kamicane/some-module.js
24 relative.resolve('some-package', '/home/kamicane'); // /home/kamicane/node_modules/some-package/index.js
25 var isTrue = relative.resolve('./some-module.js', process.cwd()) === relative.resolve('./some-module.js');
26 ```