logger-clearable v2.3.0-next.1575914912.d153a205ca18f5b3b55e886bbebe476e794435af

A logger that is clearable

npm

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
  }
}

Usage

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()
})

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

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

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

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

Unless stated otherwise all works are:

and licensed under: