Module: logger - Multipurpose Calculator Documentation

Logger for debugging and calculation output

Source:

logger.js, line 1

Requires

module:arial

Members

(static) debugEnabled

Status of debugging, exported to allow modules to pre-fill their own test values

Source:

logger.js, line 37

(static) enabled

Status of logger, determines if console wrapper functions are executed

Source:

logger.js, line 32

Methods

(static) beginFunction(functionName, argsopt) → {undefined}

Shortcut to start a group with the name of a function and its arguments

Parameters:

Name	Type	Attributes	Description
`functionName`	String		Name of the function, to serve as the group caption
`args`	Array.<Any>	<optional>	The function's arguments object

Source:

logger.js, line 257

Example

LOG.beginFunction('myFunctionName', arguments);

(static) deep(obj)

Log an object to the console as a deep copy

Parameters:

Name	Type	Description
`obj`	any

Source:

logger.js, line 302

(static) enable()

Enables logging

Source:

logger.js, line 42

(static) endResult(res)

Shortcut for LOG.log({result: res});LOG.groupEnd()

Parameters:

Name	Type	Description
`res`	Any	result of function

Source:

logger.js, line 289

(static) error(msg, title) → {undefined}

Wrapper for console.error, dependent on whether logging has been enabled

Parameters:

Name	Type	Description
`msg`	String	Error message to log to console
`title`	String	Title for error message

Source:

logger.js, line 209

(static) exitFunction(resopt) → {undefined}

Use when exiting a function due to missing or invalid input(s)

Parameters:

Name	Type	Attributes	Description
`res`	Any	<optional>	Result of the function

Source:

logger.js, line 274

(static) group(msg) → {undefined}

Wrapper for console.group, dependent on whether logging has been enabled

Parameters:

Name	Type	Description
`msg`	String	Message to log to console

Source:

logger.js, line 228

(static) groupCollapsed(msg) → {undefined}

Wrapper for console.groupCollapsed, dependent on whether logging has been enabled

Parameters:

Name	Type	Description
`msg`	String	Message to log to console

Source:

logger.js, line 237

(static) groupEnd() → {undefined}

Wrapper for console.groupEnd, dependent on whether logging has been enabled

Source:

logger.js, line 245

(static) log(msg, title) → {undefined}

Wrapper for console.log, dependent on whether logging has been enabled.

Parameters:

Name	Type	Description
`msg`	String \| Object \| Array	Message to log to console
`title`	String	Title for message

Source:

logger.js, line 60

(static) logArgs(msg) → {undefined}

Wrapper for console.log when using multiple arguments or colors Used when behavior of the log() function is not desired.

Parameters:

Name	Type	Description
`msg`

Source:

logger.js, line 75

(static) presetValues()

Enables debugger

Source:

logger.js, line 50

(static) warn(msg, title) → {undefined}

Wrapper for console.warn, dependent on whether logging has been enabled

Parameters:

Name	Type	Description
`msg`	String	Warning message to log to console
`title`	String	Title for warning message

Source:

logger.js, line 219

(inner) printArray(arr) → {String}

Takes an array of [label, value] arrays and converts to text/html with breaks after each line, padded with nonbreaking spaces so values will be aligned. Labels with an empty string as their value will not be included.

Parameters:

Name	Type	Description
`arr`	Array.<Array.<String>>	Array of any length, each member must be an array of 2 strings

Source:

logger.js, line 351

Example

printArray([
  ['Actual Body Weight', '70 kg'],
  ['Height', '180 cm'],
]);

// resulting HTML will appear like this (in Arial):
Actual Body Weight:  70 kg
Height:              180 cm