@dorianb/logger-js v0.7.6

Logger library

logger-js is a npm logger library for NodeJS

This logger is primarly designed for a backend usage, to handle the logs of a node server, or for a bot. It's lighter and easier to use than other libraries and does not require any configuration (at least for a small/medium project). It's particulary fast and require almost no running time.

The logger will write the logs by default in the logs/ directory to the root of your project. You can change the location and the name of this folder. The default log file is logs.log.

This project is part of the vener.fr project, to collect the errors and different information of the server (express).

Installation

To install the package, just run :

npm install --save @dorianb/logger-js

Then in the .js file :

const Logger = require('@dorianb/logger-js')

Logger.info('Server is starting on port 9000')
Logger.debug('172 clients are currently connected')
Logger.warn('Unsafe call from client @7655671')
Logger.error('Socket &757@127.0.0.1 doesn\'t exist')
Logger.fatal('Internet connection lost')

Documentation

Classes

Typedefs

Logger

• Logger
  • .options ⇒ OptionsObject
  • .version ⇒ string
  • .levels ⇒ LevelsObject
  • .setOptions(opts)
  • .log(filename, level, message) ↩︎
  • .info(info, [filename]) ↩︎
  • .debug(debug, [filename]) ↩︎
  • .warn(warning, [filename]) ↩︎
  • .error(error, [filename], [opts]) ↩︎
  • .fatal(error, [filename]) ↩︎
  • .clear([...filename]) ↩︎
  • .getLevel(level) ⇒ array
  • .addLevel(newLevel) ⇒ array
  • .on(event, callback)

Logger.options ⇒ OptionsObject

Getter: Return the options of the logger
Example

const loggerOptions = Logger.options

Logger.version ⇒ string

Returns: string - the version number of the logger
Getter: Version getter
Example

const version = Logger.version

Logger.levels ⇒ LevelsObject

Getter: Levels object getter - All the levels of the logger
Example

const levels = Logger.levels

Logger.setOptions(opts)

Example

Logger.setOptions({filename: 'production.log'})

Logger.log(filename, level, message) ↩︎

Chainable

Example

Logger.log('network.log', 'WARN', 'Socket disconnected')
Logger.log('network.log', 2, 'Socket disconnected')
// --> [10-06-2020 06:43:51] - WARN - Socket disconnected

Logger.info(info, filename) ↩︎

Chainable

Example

Logger.info('Server has started')
Logger.info('Server has started', 'server.log')

Logger.debug(debug, filename) ↩︎

Chainable

Example

Logger.debug(`Client ID = ${clientID}`)
Logger.debug(`Client ID = ${clientID}`, 'clients.log')

Logger.warn(warning, filename) ↩︎

Chainable

Example

Logger.warn(`Database disconnected`)
Logger.warn(`Database disconnected`, 'connections.log')

Logger.error(error, filename, opts) ↩︎

Chainable

Example

Logger.error(`Connection to 127.0.0.1:2000 refused`)
Logger.error(`Connection to 127.0.0.1:2000 refused`, 'logs.log')

Logger.fatal(error, filename) ↩︎

Chainable

Example

Logger.fatal(`Division by zero`)
Logger.fatal(`Division by zero`, 'big_errors.log')

Logger.clear(...filename) ↩︎

Chainable

Example

Logger.clear() // clear the default file (options.filename)
Logger.clear('client.log')
Logger.clear('client.log', 'connections.log', 'logs.log')
Logger.clear('all')

Logger.getLevel(level) ⇒ array

Returns: array - index, label

Example

const testLevel = Logger.getLevel('warn') // --> ["2", "WARN"]
const testLevel = Logger.getLevel(2)      // --> ["2", "WARN"]

Logger.addLevel(newLevel) ⇒ array

Returns: array - the level array : index, label

Example

const [importantLevel, importantLabel] = Logger.addLevel('Important')
Logger.log('logs.log', importantLevel, 'Important message which will be display on top of all other levels')

Logger.on(event, callback)

Example

Logger.on('log', log => console.log(log))
Logger.on('error', handleErrorsFunction)

LevelsObject : Object

A dictionary of the logger levels indexed by priority

Example

levels = {
     0: 'INFO',
     1: 'DEBUG',
     2: 'WARNING',
     3: 'ERROR',
     4: 'FATAL'
 }

OptionsObject : Object

Properties

2020 © Dorian Beauchesne