winston-console-transport

provides a console transport for winston logger

Usage no npm install needed!

<script type="module">
  import winstonConsoleTransport from 'https://cdn.skypack.dev/winston-console-transport';
</script>

README

winston-console-transport

provides a console transport for winston logger.

Version Bundle size Downloads

CodeFactor SonarCloud Codacy Total alerts Language grade Scrutinizer

Dependencies Security Build Status Coverage Status

Commit activity FOSSA License

Table of Contents

Motivation

Winston has its own console transport. But if you'll try to use it in the browser, you will find out its inconvenience. You can't access native browser console levels (ex. verbose), so it is impossible to filter those levels using the browser console.

Requirements

Platform Status

To use library you need to have node and npm installed in your machine:

  • node >=10
  • npm >=6

Package is continuously tested on darwin, linux, win32 platforms. All active and maintenance LTS node releases are supported.

Installation

To install the library, run the following command:

npm i --save winston-console-transport

Usage

To use new transport, just add it to the transports option of your winston logger.

import { createLogger } from 'winston';
import Console from 'winston-console-transport';

const logger = createLogger({
    level      : 'debug',
    transports : [ new Console() ]
});

logger.verbose('VERBOSE TEXT');

Attributes

Some attributes can be passed to new Console({})

  • name - name of a transport (default 'console')
  • eol - end of line (default os.EOL)
  • logger - custom logger (default console)
  • levels - custom level handlers (default {})
  • fallBackLogger - default level handler (default console.log)
  • sanitizer - input data sanitizer and transformator (default data => data)
  • maxListeners - max number of listeners (default 30)

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.