module-finder
Finds and filters locally and/or globally installed modules using MongoDB like queries.
Installation
Install module-finder
using npm:
npm install --save module-finder
Usage
Module usage
var moduleFinder = ; // Example:// find all locally installed modules with// version numbers below 1.0.0, which has// "test" as one of their keywords and// that has XO as a `devDependency`:;
API
moduleFinder(options)
Name | Type | Description |
---|---|---|
options | Object |
Options, see below |
Returns: Promise
, which resolves to all found modules according to given options
.
Options
Key | Type | Default | Description |
---|---|---|---|
local | Boolean |
false |
Specifies if module-finder will search for local modules |
global | Boolean |
false |
Specifies if module-finder will search for global modules |
recursive | Boolean |
false |
If set all nested node_modules folders will be searched as well |
cwd | String |
NULL |
Set current working directory, affects what counts as local modules |
filter | Object |
{} |
A MongoDB like query object to filter modules by, see below |
options.filter
The passed filter object is passed to Sift which filters the found modules by their package.json
contents accordingly.
A special Sift operator exists: $version
(see the code example above) which takes a string to use as the range argument to semver.satisfies()
.
License
MIT © Joakim Carlstein