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
· 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.
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.
topLastErrorText
· 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.
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.
topLastMethodSuccess
· 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.
topVerboseLogging
· 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.
topVersion
· string, read-only
Methods
Clear
· Does not return anything (returns Undefined).
· initialTag String
Clears the log. The initialTag is the initial top-level context tag for the new log.
topEnterContext
· Does not return anything (returns Undefined).
· tag String
Enters a new context labelled with the given tag. Must be paired with a matching call to LeaveContext.
LeaveContext
· Does not return anything (returns Undefined).
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.)
topLogData
· Does not return anything (returns Undefined).
· tag String
· message String
Adds a tagged message to the log (i.e. a name/value pair).
topLogDataBase64
· Does not return anything (returns Undefined).
· tag String
· data Buffer
Logs binary data in base64 format.
topLogDataHex
· Does not return anything (returns Undefined).
· tag String
· data Buffer
Logs binary data in hex format.
topLogDataMax
· Does not return anything (returns Undefined).
· tag String
· message String
· maxNumChars Number
Logs a string, but only up to the 1st maxNumChars characters of the string.
topLogDateTime
· Does not return anything (returns Undefined).
· tag String
· gmt Boolean
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.
topLogError
· Does not return anything (returns Undefined).
· message String
Logs an error within the current context.
topLogInfo
· Does not return anything (returns Undefined).
· message String
Logs an informational message within the current context.
topLogInt
· Does not return anything (returns Undefined).
· tag String
· value Number
Logs an integer.
topLogInt64
· Does not return anything (returns Undefined).
· tag String
· value Number
Logs a 64-bit integer.
topLogTimestamp
· Does not return anything (returns Undefined).
· tag String
Logs the current time in HH:MM:SS:mmm format.
top