diff options
Diffstat (limited to 'deps/npm/node_modules/npm-audit-report/README.md')
| -rw-r--r-- | deps/npm/node_modules/npm-audit-report/README.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/deps/npm/node_modules/npm-audit-report/README.md b/deps/npm/node_modules/npm-audit-report/README.md index 73ef382c53..1d1697f4f5 100644 --- a/deps/npm/node_modules/npm-audit-report/README.md +++ b/deps/npm/node_modules/npm-audit-report/README.md @@ -20,6 +20,9 @@ The response is an object that contains an output string (the report) and a sugg ``` 'use strict' const Report = require('npm-audit-report') +const options = { + reporter: 'json' +} Report(response, options, (result) => { console.log(result.report) @@ -30,11 +33,8 @@ Report(response, options, (result) => { ## options -reporter: - specify which output format you want to use (install, detail, json) - -withColor: - true || false indicates if some report elements should use colors or not - -withUnicode: - true || false indicates if unicode characters should be used or not. +| option | values | default | description | +| :--- | :--- | :--- |:--- | +| reporter | `install`, `detail`, `json`, `quiet` | `install` | specify which output format you want to use | +| withColor | `true`, `false` | `true` | indicates if some report elements should use colors | +| withUnicode | `true`, `false` | `true` | indicates if unicode characters should be used|
\ No newline at end of file |