# good-console

> Console broadcasting for Good process monitor

Latest version **8.0.0** (published 2019-02-12) · BSD-3-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install good-console
pnpm add good-console
yarn add good-console
bun add good-console
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.0.0 |
| Published | 2019-02-12 |
| First published | 2014-10-31 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 75 |
| Maintainers | hueniverse |

## Links

- npm: https://www.npmjs.com/package/good-console
- Repository: https://github.com/hapijs/good-console
- Homepage: https://github.com/hapijs/good-console#readme
- Issues: https://github.com/hapijs/good-console/issues
- npm.io page: https://npm.io/package/good-console

## Dependencies (4)

- [joi](https://npm.io/package/joi.md) 14.x.x
- [hoek](https://npm.io/package/hoek.md) 6.x.x
- [moment](https://npm.io/package/moment.md) 2.x.x
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) 5.x.x

## Recent versions

- 8.0.0 (latest) — 2019-02-12
- 7.1.0 — 2018-02-15
- 7.0.1 — 2018-01-29
- 7.0.0 — 2018-01-17
- 6.4.1 — 2017-12-05
- 6.4.0 — 2017-02-08
- 6.1.3 — 2016-12-09
- 6.2.0 — 2016-12-08
- 6.3.1 — 2016-10-24
- 6.1.2 — 2016-05-27
- 6.1.1 — 2016-05-02
- 5.3.2 — 2016-04-21
- 6.1.0 — 2016-04-21
- 6.0.0 — 2016-03-30
- 5.3.1 — 2016-02-05
- … 19 more at https://npm.io/package/good-console/versions

## README

# good-console

`good-console` is a transform stream useful for turning [good](https://github.com/hapijs/good) server events into formatted strings.

[![Build Status](https://travis-ci.org/hapijs/good-console.svg?branch=master)](http://travis-ci.org/hapijs/good-console)
[![Current Version](https://img.shields.io/npm/v/good-console.svg)](https://www.npmjs.com/package/good-console)

Lead Maintainer: [Open Position](https://github.com/hapijs/good-console/issues/108)

Requires node v8 or above. Use version v7 of this module for node v6 support.

## Usage

## `new GoodConsole([config])`
Creates a new GoodConsole object with the following arguments:

- `[config]` - optional configuration object with the following keys
	- `format` - [MomentJS](http://momentjs.com/docs/#/displaying/format/) format string. Defaults to 'YYMMDD/HHmmss.SSS'.
	- `utc` - boolean controlling Moment using [utc mode](http://momentjs.com/docs/#/parsing/utc/) or not. Defaults to `true`.
	- `color` - a boolean specifying whether to output in color. Defaults to `true`.

## Output Formats

Below are example outputs for the designated event type:

- "ops" - 160318/013330.957, [ops] memory: 29Mb, uptime (seconds): 6, load: [1.650390625,1.6162109375,1.65234375]
- "error" - 160318/013330.957, [error,`event.tags`] message: Just a simple error, stack: `event.error.stack`
- "request" - 160318/013330.957, [request,`event.tags`] data: you made a request
- "log" - 160318/013330.957, [log,`event.tags`] data: you made a default
- "response" - 160318/013330.957, [response, `event.tags`] http://localhost:61253: post /data {"name":"adam"} 200 (150ms)

---
_Source: https://npm.io/package/good-console · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._