Wondering what’s next for npm?Check out our public roadmap! »

@boundstate/good-consoleTypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

@boundstate/good-console

Transform stream useful for turning good server events into formatted strings.

This is a TypeScript rewrite of hapijs/good-console with the same API but some notable changes:

  • Only the stack property of errors are logged (message is included in stack so it's redundant)
  • More friendly & colourful messages
  • The log and request tags are not displayed unless they are the only tag

Usage

new GoodConsole([config])

Creates a new GoodConsole object with the following arguments:

  • [config] - optional configuration object with the following keys
    • format - MomentJS format string. Defaults to 'YYMMDD/HHmmss.SSS'.
    • utc - boolean controlling Moment using utc mode 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" - 2016-03-18 01:33:30.957, [ops] memory: 29Mb, uptime (seconds): 6, load: [1.650390625,1.6162109375,1.65234375]
  • "error" - 2016-03-18 01:33:30.957, [error,event.tags] event.error.stack
  • "request" - 2016-03-18 01:33:30.957, [event.tags] you made a request
  • "log" - 2016-03-18 01:33:30.957, [event.tags] you made a default
  • "response" - 2016-03-18 01:33:30.957, [response, event.tags] POST /data {"name":"adam"} 200 150ms

Keywords

none

Install

npm i @boundstate/good-console

DownloadsWeekly Downloads

7

Version

1.0.1

License

MIT

Unpacked Size

17.1 kB

Total Files

7

Last publish

Collaborators

  • avatar
  • avatar