Log Node.js Reference Documentation

Log

Current Version: 10.1.2

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

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

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText
· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess
· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

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 "10.1.0"

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