99voices_npm_logger

1.0.4 • Public • Published

Logger

This package contains a logger. It is build on, and defacto returns an instance of winston. For an in depth Overview of the api of the object returned by this package, see the documentation of winston.

Development

This package is developed within a docker container. Run scripts/build.sh and scripts/run.sh to obtain the development environment. For every yarn operation exec into the container docker exec -it ${container_id} /bin/ash and run the opreation inside yarn .... The container watches for file changes on the sources and automatically rebuilds the distribution code. Before running yarn publish be sure to run yarn login.

Usage

This package contains and returns a singleton. Meaning that you can require the file wherever you want to, and you will always obtain the same logging instance. In order for this to work it is vital that the logger instance is first initialized. This is a synchronous process and done like this:

import Config from '99voices_npm_config';
import Logger from '99voices_npm_logger';

let config = Config();
let Logger = Logger({config});

logWithRequest

This package adds a custom method logWithRequest(level,request,message,data) to the logger instance. It is useful when logging during web processes. It accepts the following options:

  • level String - The log level. See winston for more info
  • request Express.request - The request that this log relates to
  • message String - Your message. logWithRequest will reformat the message and add request meta data to it
  • data Object - An object you want to log. See winston for more info

Readme

Keywords

none

Package Sidebar

Install

npm i 99voices_npm_logger

Weekly Downloads

1

Version

1.0.4

License

MIT

Last publish

Collaborators

  • designtesbrot