Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs
  • Loading branch information
75lb committed May 19, 2019
1 parent c9fff85 commit fa4e0f0
Show file tree
Hide file tree
Showing 4 changed files with 150 additions and 119 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -33,8 +33,8 @@ Node's `require` with a few extra features:
| --- | --- | --- |
| request | <code>string</code> | The module name, directory or file to load. |
| [options] | <code>object</code> | |
| [options.prefix] | <code>string</code> | Also attempt to load the given module name with this prefix. |
| [options.paths] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | One or more additional directories in which to search for modules. |
| [options.paths] | <code>string</code> \| <code>Array.&lt;string&gt;</code> | One or more additional directories in which to search for modules. For each path specified, both the path itself and `${path}/node_modules` will be searched. |
| [options.prefix] | <code>string</code> | Attempt to load the given module name with this prefix. Only useful where `request` is a module name. |


* * *
Expand Down
4 changes: 2 additions & 2 deletions index.js
Expand Up @@ -19,8 +19,8 @@
* @alias module:load-module
* @param {string} - The module name, directory or file to load.
* @param {object} [options]
* @param {string} [options.prefix] - Also attempt to load the given module name with this prefix.
* @param {string|string[]} [options.paths] - One or more additional directories in which to search for modules.
* @param {string|string[]} [options.paths] - One or more additional directories in which to search for modules. For each path specified, both the path itself and `${path}/node_modules` will be searched.
* @param {string} [options.prefix] - Attempt to load the given module name with this prefix. Only useful where `request` is a module name.
*/
function loadModule (request, options) {
if (typeof request !== 'string') {
Expand Down

0 comments on commit fa4e0f0

Please sign in to comment.