Class Debug

Object
   |
   +--Debug

class Debug

Defined in debug.js

Constructor Detail

Debug

function Debug()

assert

void assert(cond, varArgs)

Asserts that cond is true. assert returns immediately if cond is true. If cond is false, then assert sends str to the console, prepended by 'ERROR: ', styled as red, bold text on a white background, and then throws str as an exception.

Parameters:
cond - a boolean which must be true, or assert will throw an exception
str - a string to display (and throw) if cond is false.

clear

void clear()

Empties the console of any child nodes--effectively clearing it.

WARNING: if the console contains child nodes not related to debug output, this function will delete them, too.

dumpArray

void dumpArray(arr)

Prints an array to the debug console in a nice way.

Parameters:
arr - the array to print

dumpObject

void dumpObject(obj)

Prints an object to the console in object-literal syntax.

Parameters:
obj - the object to print out

print

void print(varArgs)

Prepends str to the console.

Parameters:
str - the string to prepend to the console

setConsole

Object setConsole(element)

Initializes the console to element. Returns the old console, or null if there wasn't one.

setTrace

void setTrace(<boolean> newTracing)

Turns tracing on or off. If tracing is true and the debug console is non-null then calls to traceIn and traceOut will produce output.

Parameters:
newTracing - after this function returns, traceIn and traceOut will produce output only if newTracing is true.

traceIn

void traceIn(funcName, args)

Prints --> funcName([args[0][, args[1][, ...]]]) to the console. Puts funcName on top of the tracing stack.

Parameters:
funcName - the name of the function being traced into
args - the array of arguments passed to the traced function. Typically the predefined arguments array is passed for args.

traceOut

Object traceOut(retVal)

Pops a function name off the tracing stack and prints it. If retVal is defined, then the function name is followed by a string version of retVal. retVal is returned, even if tracing is turned off. This means you can say return Debug.traceOut(ret); even if tracing is turned off.

Parameters:
retVal - the value to return

Returns:
retVal is always returned