Class Index | File Index

Classes


Namespace mmir.Logging


Defined in: logger.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
A Logger factory.
Field Summary
Field Attributes Field Name and Description
<private>  
Method Summary
Method Attributes Method Name and Description
 
create(loggerName, logLevel)
Creates a Logger instance.
 
Print debug message with default logger.
 
Print error with default logger.
 
Sets the default log-level.
 
info()
Print information message with default logger.
 
log()
Print log output with default logger.
 
Sets the default log-level.
 
Print verbose output with default logger.
 
warn()
Print warning message with default logger.
Namespace Detail
mmir.Logging
A Logger factory.
 //use logger
 var Logger = require('logger');
 var log = Logger.create('example');
 
 if(log.isVerbose()) log.debug('test');//will write the message to debug-console)
 log.error(new Error());//will write the error (including its stack) to error console)
 
 //example for setting up a logger in a requirejs-module:
 define(['logger', 'module'], function(Logger, module){
 
   var logger = Logger.create(module);
   //this would create the same logger-object:
   //  Logger.create(module.id, module.config().logLevel);
   
   //use the logger instance...
   
   //create / retrieve the same logger
   var sameLogger = Logger.create(module.id);
   
 });
See:
Logger
Field Detail
<private> {Logger} Logger#-_defaultLogger
Method Detail
{Logger} create(loggerName, logLevel)
Creates a Logger instance. If a logger for loggerName already exists, the existing logger is returned (instead of creating a new one).
Parameters:
{String|Object} loggerName Optional
If String: a name / ID for the logger that should be created / retrieved.
If Object: an requirejs module object, i.e. should contain properties id (String) which will set the loggerName, and a property/function config (Function) that returns an object with property logLevel (i.e. config().logLevel should be valid).
If omitted, the default logger will be returned.
{String} logLevel Optional
a name / ID for the logger that should be created / retrieved. If omitted, the default logger will be returned.
Returns:
{Logger} the created (or retrieved) logger
See:
Logger
Logger#setLevel

debug()
Print debug message with default logger.
See:
Logger#debug

error()
Print error with default logger.
See:
Logger#error

{Number} getDefaultLogLevel()
Sets the default log-level.
Returns:
{Number} the log level: a number between 0 (verbose) and 6 (disabled)
See:
#setDefaultLogLevel
Logger#getLevel

info()
Print information message with default logger.
See:
Logger#info

log()
Print log output with default logger.
See:
Logger#log

setDefaultLogLevel(theLevel)
Sets the default log-level. This setting is used by loggers, that do not have a specific log-level set.
Parameters:
{Number} theLevel
the log level: a number between 0 (verbose) and 6 (disabled)
See:
#getDefaultLogLevel
Logger#getLevel

verbose()
Print verbose output with default logger.
See:
Logger#verbose

warn()
Print warning message with default logger.
See:
Logger#warn

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 26 2016 21:44:43 GMT+0100 (Mitteleuropäische Zeit)