Log Node.js Reference Documentation

Log

Current Version: 10.0.0

Handy logging class exposing much of the functionality used internally by Chilkat for LastErrorText, LastErrorXml, and LastErrorHtml.

Object Creation

var obj = new chilkat.Log();

Properties

DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples
top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText
· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess
· boolean

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
VerboseLogging
VerboseLogging
· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version
· string, read-only

Version of the component/library, such as "9.5.0.94"

More Information and Examples
top

Methods

Clear
Clear(initialTag);
· Does not return anything (returns Undefined).
· initialTag String
Introduced in version 9.5.0.44

Clears the log. The initialTag is the initial top-level context tag for the new log.

top
EnterContext
EnterContext(tag);
· Does not return anything (returns Undefined).
· tag String
Introduced in version 9.5.0.44

Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.

More Information and Examples
top
LeaveContext
LeaveContext();
· Does not return anything (returns Undefined).
Introduced in version 9.5.0.44

Leaves the current context. A context that is entered and exited without any logging within the context is automatically removed from the log. (To say it another way: Empty contexts are automaticallly removed from the log upon leaving the context.)

top
LogData
LogData(tag, message);
· Does not return anything (returns Undefined).
· tag String
· message String
Introduced in version 9.5.0.44

Adds a tagged message to the log (i.e. a name/value pair).

top
LogDataBase64
LogDataBase64(tag, data);
· Does not return anything (returns Undefined).
· tag String
· data Buffer
Introduced in version 9.5.0.44

Logs binary data in base64 format.

top
LogDataHex
LogDataHex(tag, data);
· Does not return anything (returns Undefined).
· tag String
· data Buffer
Introduced in version 9.5.0.44

Logs binary data in hex format.

top
LogDataMax
LogDataMax(tag, message, maxNumChars);
· Does not return anything (returns Undefined).
· tag String
· message String
· maxNumChars Number
Introduced in version 9.5.0.44

Logs a string, but only up to the 1st maxNumChars characters of the string.

top
LogDateTime
LogDateTime(tag, gmt);
· Does not return anything (returns Undefined).
· tag String
· gmt Boolean
Introduced in version 9.5.0.44

Logs the current date/time in RFC822 format. If gmt is true, then the GMT/UTC time is logged. Otherwise it is the local time.

top
LogError
LogError(message);
· Does not return anything (returns Undefined).
· message String
Introduced in version 9.5.0.44

Logs an error within the current context.

top
LogInfo
LogInfo(message);
· Does not return anything (returns Undefined).
· message String
Introduced in version 9.5.0.44

Logs an informational message within the current context.

top
LogInt
LogInt(tag, value);
· Does not return anything (returns Undefined).
· tag String
· value Number
Introduced in version 9.5.0.44

Logs an integer.

top
LogInt64
LogInt64(tag, value);
· Does not return anything (returns Undefined).
· tag String
· value Number
Introduced in version 9.5.0.44

Logs a 64-bit integer.

top
LogTimestamp
LogTimestamp(tag);
· Does not return anything (returns Undefined).
· tag String
Introduced in version 9.5.0.44

Logs the current time in HH:MM:SS:mmm format.

top