@ahmedelazazy/logger-js v1.1.1

Logger JS

A minimal package to help logging into Console & text files. Flexible API to accept several types.

Has basic options to enable/disable Console logging and enable/disable File logging.

Can control the logs mode to be cleared everytime, appended, or saved into new folder.

Who shall use this?

If you are looking for a quick way to save your logs formatted with timestamp to text files, here you go.

Installation

npm i @ahmedelazazy/logger-js

Getting Started

const { log } = require('@ahmedelazazy/logger-js')

log('test logger')

// Output:
// {
//   datetime: 'Tue, 2/22/2022, 01:11:39 PM UTC',
//   unix: 1645535436,
//   function: null,
//   message: 'test logger'
// }

• Optionally call init once on startup with the settings

const { log } = require('@ahmedelazazy/logger-js')

const options = { timeZone: 'America/New_York' }

init(options)

log({ message: 'data example', data: { a: 1, b: 2 } })

// Output:
// {
//   datetime: 'Tue, 2/22/2022, 08:08:43 AM EST',
//   unix: 1645535323,
//   function: null,
//   message: 'data example',
//   data: { a: 1, b: 2 }
// }

Log Record Fields

• datetime a human readable date/time of the log - the time zone is configured from the init options
• unix the unix value of the log time
• function the name of the function where the record was logged
• message optional - a text message
• data optional - an object to be logged
• error optional - thrown exception

Every record should have at least one of the parameters: message, data or error.

Init Options

You can customize the log, to enable/disable Console & Files

API

log: Function (string | number | boolean | object | error | options)

• String
• Number
• Boolean

log('test message') //valid
log(1) //valid
log(true) //valid

• Object

log({ name: 'A', num: 1 }) //valid

• Error object

try {
	invalidFn()
} catch (err) {
	log(err) //valid
}

• Options: {message, data, error}

try {
	const response = await getData()

	log({
		message: 'Data fetched successfully',
		data: response,
	})
} catch (err) {
	log({
		message: 'Error while fetching data',
		error: err,
	})
}

init: Function (options)

• Options

{
	enableFileLog: false,
	enableFileError: true,
	enableFileInfo: true,
	enableConsoleError: true,
	enableConsoleInfo: true,
	timeZone: 'UTC',
	logsMode: 'append',
}