Package Exports

npm-audit-report

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (npm-audit-report) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm audit security report

Given a response from the npm security api, render it into a variety of security reports

The response is an object that contains an output string (the report) and a suggested exitCode.

{
  report: 'string that contains the security report',
  exit: 1
}

Basic usage example

'use strict'
const Report = require('npm-audit-report')
const options = {
  reporter: 'json'
}

Report(response, options, (result) => {
  console.log(result.report)
  process.exitCode = result.exitCode
})

options

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