diff --git a/README.md b/README.md index d4eecfb..911b673 100644 --- 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] | object | Optional parameters. | -| [options.dir] | string | The path where to look for the package.json file. | -| [options.logger] | object | A logger instance, with a similar API as the console object. | +| Param | Type | Description | +| --------------------- | -------------------- | ------------------------------------------------------------ | +| [options] | object | Optional parameters. | +| [options.autoUpgrade] | boolean | Automatically upgrade all suggested dependencies. | +| [options.dir] | string | The path where to look for the package.json file. | +| [options.logger] | object | A logger instance, with a similar API as the console object. | ## License diff --git a/lib/index.js b/lib/index.js index ed5f548..71d5982 100644 --- 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. */