winston-array-transport

winston-array-transport

write winston logs directly to javascript Array.

Table of Contents

• Motivation
• Requirements
• Installation
• Usage
• Configuration
• Contribute

Motivation

There are a lot of cases where you need to parse and analyze your logs. For example, to access them during tests. This package provides transport that allows simply push logs to js array, so you don't need any runtime parsers anymore.

Requirements

<<<<<<< HEAD

081e4ed03eebef0eda5305a1486a32cf91cdc62b

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-array-transport

Usage

The package can be used alongside any other winston transport.

import ArrayTransport from 'winston-array-transport';
import { createLogger } from 'winston';

const logs = [];
const transport  = new ArrayTransport({ array: logs, json: true, level: 'info' });

export const logger = createLogger({
    transports : [ transport ]
});

Configuration

Next options can be configured while transport creation:

• name - name of a transport, ArrayTransport by default;
• eol - end of line , os.EOL by default;
• array - array, where all logs will be stored;
• parser - function, that will be applied to log messages;
• json - if set to true, JSON.parse parser will be used;
• limit - allows to limit amount of logs to n last items;

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.

<<<<<<< HEAD npm-downloads-badge: https://img.shields.io/npm/dw/winston-array-transport npm-size-badge: https://img.shields.io/bundlephobia/min/winston-array-transport npm-size-url: https://bundlephobia.com/result?p=winston-array-transport

081e4ed03eebef0eda5305a1486a32cf91cdc62b

Changelog

1.1.2 (2021-05-25)

Chore

• 'Chore' semanticCommitType for updating devDependencies (4bf79e1)
• (tests) clearCache on module load is optional (96c2ae5)
• (tests) moves load to factory (4acb941)
• additional quotes in glob pattern (f6d15cf)
• adds appveyor (d560b4e)
• contributor login in danger message (76349e6)
• dont store package-tests artifacts (50ebff1)
• fixes prevent require handler (7923f0e)
• fixes spellcheck in bugreport (7d754b6)
• integrate APPVEYOR_BUILD_ID to build tests (16cdd48)
• not fail package if no tmp exists (5693813)
• package-tester improvements (d5d868b)
• prevent package:test from using devdependencies (dc896f3)
• set myself as default assignee in pr (0dcd0ce)
• tests/entry.js module resolving (c840f8b)
• update default renovate rules (7e83bc4)
• Update dependency @rollup/plugin-commonjs to v19 (bf29948)
• update eslint (4aac03c)
• update lock file (4ffb878)

Docs

• adds node releases roadmap (ba16142)
• move Contributing Guidelines to separate file. (081e4ed)