Gecko [ touzafair.com ]

Name	Size	Permission
lib	[ DIR ]	drwxr-xr-x
reporters	[ DIR ]	drwxr-xr-x
CHANGELOG.md	3.07 KB	-rw-r--r--
LICENSE	755 B	-rw-r--r--
README.md	1.5 KB	-rw-r--r--
index.js	588 B	-rw-r--r--
package.json	1.94 KB	-rw-r--r--

Code Editor : README.md

# npm audit security report

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

[![Build Status](https://travis-ci.org/npm/npm-audit-report.svg?branch=master)](https://travis-ci.org/npm/npm-audit-report)
[![Build status](https://ci.appveyor.com/api/projects/status/qictiokvxmqkiuvi/branch/master?svg=true)](https://ci.appveyor.com/project/evilpacket/npm-audit-report/branch/master)
[![Coverage Status](https://coveralls.io/repos/github/npm/npm-audit-report/badge.svg?branch=master)](https://coveralls.io/github/npm/npm-audit-report?branch=master)

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

${this.title}

Code Editor : README.md