ServerSentEvent Node.js Reference Documentation
ServerSentEvent
Current Version: 11.0.0
Represents a server-sent event (SSE) received from an HTTP text/event-stream.
Object Creation
var obj = new chilkat.ServerSentEvent();
Properties
Data
· string, read-only
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
topDebugLogFilePath
· 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.
EventName
· string, read-only
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastErrorHtml
· 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.
topLastEventId
· string, read-only
The content of the "id" field, if present.
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.
Retry
· integer, read-only
The integer value of the "retry" field, if it exists; otherwise, 0.
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.
Version
· string, read-only
Methods
LoadEvent
· Returns Boolean (true for success, false for failure).
· eventText String
Loads the multi-line event text into this object. For example, the eventText for a Firebase event might look like this:
event: put data: {"path": "/c", "data": {"foo": true, "bar": false}}
Returns true for success, false for failure.