Add documentation

lifion · Jan 16, 2020 · 70fd6a8 · 70fd6a8
1 parent f0296d0
commit 70fd6a8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -36,11 +36,12 @@ Verifies the dependencies listed in the package.json of the given directory.
 
 **Kind**: Exported function
 
-| Param            | Type                | Description                                                  |
-| ---------------- | ------------------- | ------------------------------------------------------------ |
-| [options]        | <code>object</code> | Optional parameters.                                         |
-| [options.dir]    | <code>string</code> | The path where to look for the package.json file.            |
-| [options.logger] | <code>object</code> | A logger instance, with a similar API as the console object. |
+| Param                 | Type                 | Description                                                  |
+| --------------------- | -------------------- | ------------------------------------------------------------ |
+| [options]             | <code>object</code>  | Optional parameters.                                         |
+| [options.autoUpgrade] | <code>boolean</code> | Automatically upgrade all suggested dependencies.            |
+| [options.dir]         | <code>string</code>  | The path where to look for the package.json file.            |
+| [options.logger]      | <code>object</code>  | A logger instance, with a similar API as the console object. |
 
 ## License
 

diff --git a/lib/index.js b/lib/index.js
@@ -67,6 +67,7 @@ function getPkgIds(filteredPkgs) {
  *
  * @alias module:lifion-verify-deps
  * @param {object} [options] - Optional parameters.
+ * @param {boolean} [options.autoUpgrade] - Automatically upgrade all suggested dependencies.
  * @param {string} [options.dir] - The path where to look for the package.json file.
  * @param {object} [options.logger] - A logger instance, with a similar API as the console object.
  */