optional-require - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

package.json

 {
   "name": "optional-require",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Optional Require",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -11,5 +11,6 @@ # Optional Require
 const foo = optionalRequire("foo") || {};
-const bar = optionalRequire("bar", true); // true enables console.log a message
+const bar = optionalRequire("bar", true); // true enables console.log a message when not found
 const xyz = optionalRequire("xyz", "test"); // "test" enables console.log a message with "test" added.
 const fbPath = optionalRequire.resolve("foo", "foo doesn't exist");
+const rel = optionalRequire("../foo/bar"); // relative module path works
 ```
@@ -23,2 +24,28 @@
 
+# API
+
+#### [optionalRequire(require)]()
+
+The single function this module exports.  Call it with `require` to get a custom function for your file to do optional require.  See [Usage](#usage) above.
+
+#### [customOptionalRequire(path, [message])]()
+
+The function [optionalRequire]() returns for your file to do optional require in your file.
+
+##### Params
+
+  - `path` - name/path to the module your want to optionally require
+  - `message` - optional flag/message to enable `console.log` a message when module is not found
+
+##### Returns
+  - module required or `undefined` if not found
+
+##### Throws
+
+  - rethrows any error that's not `MODULE_NOT_FOUND` for the module `path`
+
+#### [customOptionalRequire.resolve(path, [message])]()
+
+Same as [customOptionalRequire]() but acts like `require.resolve`
+
 # LICENSE
@@ -25,0 +52,0 @@

No alert changes

Improved metrics

Total package byte prevSize

2799

46.39%

Number of lines in readme file

53

103.85%

Published versions last week

2

100%

No dependency changes