REDROOM

Edit File Size: 1.50 KB

//lib/node_modules/npm/node_modules/npm-audit-report/README.md

Text Base64

# 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

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
lib DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
reporters DIR	-	drwxr-xr-x	2024-03-03 22:36:29	Edit Download recursive recursive
CHANGELOG.md	3.07 KB	lrw-r--r--	2021-03-10 14:36:40	Edit Download recursive recursive
index.js	588 B	lrw-r--r--	2021-03-10 14:36:40	Edit Download recursive recursive
LICENSE	755 B	lrw-r--r--	2021-03-10 14:36:40	Edit Download recursive recursive
package.json	1.94 KB	lrw-r--r--	2021-03-10 14:36:40	Edit Download recursive recursive
README.md	1.50 KB	lrw-r--r--	2021-03-10 14:36:40	Edit Download recursive recursive

Directory Contents