winston-console-transport

provides a console transport for winston logger

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
winston-console-transport
0211.1.92 years ago5 years agoMinified + gzip package size for winston-console-transport in KB

Readme

winston-console-transport
provides a console transport for winstonw-gh logger. !Versionbadge-versnpm !Bundle sizenpm-size-badgenpm-size-url !Downloadsnpm-downloads-badgenpm !CodeFactorcodefactor-badgecodefactor-url !SonarCloudsonarcloud-badgesonarcloud-url !Codacycodacy-badgecodacy-url !Total alertslgtm-alerts-badgelgtm-alerts-url !Language gradelgtm-lg-badgelgtm-lg-url !Scrutinizerscrutinizer-badgescrutinizer-url !Dependenciesbadge-depsnpm !Securitysnyk-badgesnyk-url !Build Statustests-badgetests-url !Coverage Statusbadge-coverageurl-coverage !Commit activitycommit-activity-badgegithub !FOSSAfossa-badgefossa-url !Licensebadge-licgithub
πŸ‡ΊπŸ‡¦ Help Ukraine
I woke up on my 26th birthday at 5 am from the blows of russian missiles. They attacked the city of Kyiv, where I live, as well as the cities in which my family and friends live. Now my country is a war zone. We fight for democratic values, for freedom, for our future! I am stopping any support of my packages by the time until all russians leave my country on trucks or in boxes. πŸ’›πŸ’™ Help Ukraine! We need your support! There are dozen ways to help us, just do it!

Table of Contents

- Motivation - Requirements - Installation - Usage - Attributes

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 consoleconsole levels (ex. verbose), so it is impossible to filter those levels using the browser console.

Requirements

!Platform Statusnode-ver-test-badgenode-ver-test-url To use library you need to have node and npm installed in your machine:
  • node >=10
  • npm >=6
Package is continuously testednode-ver-test-url on darwin, linux and 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. ```javascript 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.