logger-clearable

A logger that is clearable

Usage

Complete API Documentation.

'use strict'

// create our clearable logger
const logger = require('logger-clearable').create()
const method = 'log'

// log the date every second
const timer = setInterval(function () {
    if (method === 'log') {
        const date = new Date()
        const time = date.toISOString()
        logger.log(time)
    } else {
        // the above will actually call: logger.queue(() => time)
        // instead, we can use queue directly:
        // using queue direclty is more performant as
        // any setup for our particular message will happen only if that message will be written
        // this is applicable as logger won't bother writing messages that would be cleared instantly
        // e.g. logger.log('hello').log('world') would otherwise write 'hello' then have to clear it right away
        // instead, logger just skips writing 'hello' and will just write 'world'
        logger.queue(function () {
            const date = new Date()
            const time = date.toISOString()
            return time
        })
    }
}, 100)

// on ctrl+c close the timer and discard any upcoming logs
process.on('SIGINT', () => {
    // stop any more calls to logger
    clearInterval(timer)
    // discard any logger queued updated
    logger.discard()
    // and clear the log
    logger.clear()
})

Install

npm

• Install: npm install --save logger-clearable
• Import: import * as pkg from ('logger-clearable')
• Require: const pkg = require('logger-clearable')

Editions

This package is published with the following editions:

• logger-clearable aliases logger-clearable/source/index.js
• logger-clearable/source/index.js is ESNext source code for Node.js 10 || 12 || 14 || 16 with Require for modules

TypeScript

This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

• Copyright © 2018+ Benjamin Lupton

and licensed under:

• MIT License