Class: FlatLog

flatlog.FlatLog

FlatLog

Constructor

new FlatLog(configopt) → {FlatLog}

Create new FlatLog from configuration. It help write log message simply and readable

Parameters:
Name Type Attributes Default Description
config module:flatlog.Config <optional>
{}

configuration of logger

Source:
Returns:

the new flat log object

Type
FlatLog
Example
var logger1 = new FlatLog()
var logger2 = new FlatLog({caller: 'kevin'})
var logger3 = new FlatLog({verbose: false, caller: 'stuart'})

Members

_config :module:flatlog.Config

Logger configuration. It assign by config parameter

Type:
Source:

Methods

alert(message)

Log message with ALERT level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.alert('action must be taken immediately')

critical(message)

Log message with CRITICAL level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.critical('the system is in critical condition')

debug(message)

Log message with DEBUG level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.debug('messages to debug an application')

emergency(message)

Log message with EMERGENCY level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.emergency('system is unusable')

error(message)

Log message with ERROR level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.error('error condition')

info(message)

Log message with INFO level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.info('a purely informational message')

log(level, message)

Log message to terminal by one line format

Parameters:
Name Type Description
level module:flatlog.LogLevel

Level of message

message string

Message to write

Source:
Example
// see constructor for detail
var logger = new FlatLog(config)

logger.log(LogLevel.INFO, 'start new day')
logger.log(LogLevel.NOTICE, 'work done')
logger.log(LogLevel.ERROR, 'go to workspace')

notice(message)

Log message with NOTICE level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.notice('a normal but significant condition')

warning(message)

Log message with WARNING level

Parameters:
Name Type Description
message string

log message

Source:
Example
// see constructor for detail
var logger = new Logger(config)

logger.warning('warning condition')