blob: 040c165ac8aed7aa5aba65b87805f42ac2a7440e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# is-resolvable
[](https://www.npmjs.com/package/is-resolvable)
[](https://travis-ci.org/shinnn/is-resolvable)
[](https://ci.appveyor.com/project/ShinnosukeWatanabe/is-resolvable)
[](https://coveralls.io/r/shinnn/is-resolvable)
A [Node.js](https://nodejs.org/) module to check if a given module ID is resolvable with [`require()`](https://nodejs.org/api/globals.html#globals_require)
```javascript
const isResolvable = require('is-resolvable');
isResolvable('fs'); //=> true
isResolvable('path'); //=> true
// When ./index.js exists
isResolvable('./index.js') //=> true
isResolvable('./index') //=> true
isResolvable('.') //=> true
```
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).
```
npm install is-resolvable
```
## API
```javascript
const isResolvable = require('is-resolvable');
```
### isResolvable(*moduleId* [, *options*])
*moduleId*: `string` (module ID)
*options*: `Object` ([`require.resolve`](https://nodejs.org/api/modules.html#modules_require_resolve_request_options) options)
Return: `boolean`
It returns `true` if `require()` can load a file form a given module ID, otherwise `false`.
```javascript
const isResolvable = require('is-resolvable');
// When ./foo.json exists
isResolvable('./foo.json'); //=> true
isResolvable('./foo'); //=> true
isResolvable('./foo.js'); //=> false
// When `eslint` module is installed but `jshint` isn't
isResolvable('eslint'); //=> true
isResolvable('jshint'); //=> false
// When `lodash` module is installed
isResolvable('lodash/isObject'); //=> true
isResolvable('lodash/fp/reject.js'); //=> true
```
The second argument accepts an options object for `require.resolve()`.
```javascript
// When ./bar/baz.js exists
isResolvable('./baz.js'); //=> false
isResolvable('./baz.js', {paths: ['bar']}); //=> true
```
## License
[ISC License](./LICENSE) © 2018 Shinnosuke Watanabe
|
