npm - @quotemedia.com/streamer - Versions diffs - 2.54.0 → 2.55.0 - Mend

@quotemedia.com/streamer 2.54.0 → 2.55.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/examples/enduser-example.html +1 -1
package/examples/enterprise-token-example.html +1 -1
package/examples/reconnect-example.html +1 -1
package/examples/stomp-3rd-party-library-example.html +1 -1
package/examples/subscription-example.html +1 -1
package/examples/wmid-example.html +1 -1
package/package.json +1 -1
package/{qmci-streamer-2.54.0.js → qmci-streamer-2.55.0.js} +95 -3
package/{qmci-streamer-2.54.0.min.js → qmci-streamer-2.55.0.min.js} +2 -2

package/examples/enduser-example.html CHANGED Viewed

@@ -1,7 +1,7 @@
 <html>
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
 </head>
 <body>

package/examples/enterprise-token-example.html CHANGED Viewed

@@ -1,7 +1,7 @@
 <html>
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
 </head>
 <body>

package/examples/reconnect-example.html CHANGED Viewed

@@ -1,7 +1,7 @@
 <html>
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
 </head>
 <body>

package/examples/stomp-3rd-party-library-example.html CHANGED Viewed

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/stomp.js/2.3.3/stomp.min.js"></script>
 </head>

package/examples/subscription-example.html CHANGED Viewed

@@ -1,7 +1,7 @@
 <html>
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
 </head>
 <body>

package/examples/wmid-example.html CHANGED Viewed

@@ -1,7 +1,7 @@
 <html>
 <head>
-    <script src="qmci-streamer-2.54.0.min.js"></script>
+    <script src="qmci-streamer-2.55.0.min.js"></script>
 </head>
 <body>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@quotemedia.com/streamer",
-  "version": "2.54.0",
+  "version": "2.55.0",
   "description": "A JavaScript client for QuoteMedia's streaming data service.",
   "main": "lib/index.js",
   "author": "QuoteMedia",

package/{qmci-streamer-2.54.0.js → qmci-streamer-2.55.0.js} RENAMED Viewed

@@ -524,7 +524,30 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 var CONSOLIDATED_SYMBOL_ENTITLEMENTS_COEFFICIENT = 14;
 var CONSOLIDATED_SYMBOL_SUFFIX = ":CC";
+/**
+ * Represents a bidirectional connection to the streaming service server.
+ * <p>
+ * The Stream class provides the core functionality for establishing connections to the
+ * QuoteMedia streamer service, managing subscriptions, and processing incoming messages.
+ * It handles various message types including control messages, market data, and error events.
+ * <p>
+ * Typical usage involves:
+ * 1. Creating a Stream instance
+ * 2. Setting up event handlers for messages and errors
+ * 3. Opening the connection
+ * 4. Subscribing to desired symbols and data types
+ * 5. Processing incoming data
+ * 6. Closing the connection when done
+ */
 var Stream = function () {
+    /**
+     * Creates a new Stream instance.
+     *
+     * @param {Object} streamingService - The underlying transport service
+     * @param {string} format - The message format (e.g., JSON, QMCI)
+     * @param {Object} log - The logger instance
+     */
     function Stream(streamingService, format, log) {
         var _this = this;
@@ -575,6 +598,17 @@ var Stream = function () {
         });
     }
+    /**
+     * Opens a connection to the server.
+     * <p>
+     * This call will block until either the stream is opened or the attempt fails.
+     *
+     * @param {Function} callback - Called when the connection attempt completes
+     *                             with (error, stream) parameters
+     * @throws {Error} If the stream cannot be opened
+     */
     Stream.prototype.open = function open(callback) {
         try {
             this.pendingConnection = callback;
@@ -595,6 +629,19 @@ var Stream = function () {
         return this.events.on(event, listener);
     };
+    /**
+     * Subscribes to streaming data for the specified symbols and data types.
+     * <p>
+     * This method initiates subscription requests to the server and handles the responses.
+     * The callback will be invoked when all subscription requests are processed.
+     *
+     * @param {string|Array<string>} symbols - The symbol(s) to subscribe to
+     * @param {string|Array<string>} types - The data type(s) to subscribe for
+     * @param {Object|Function} optsOrCallback - Options object or callback function
+     * @param {Function} [callbackOrNothing] - Callback function if not provided as optsOrCallback
+     */
     Stream.prototype.subscribe = function subscribe(symbols, types, optsOrCallback, callbackOrNothing) {
         var _this2 = this;
@@ -913,6 +960,19 @@ var Stream = function () {
         this.send(request);
     };
+    /**
+     * Unsubscribes from streaming data for the specified symbols and data types.
+     * <p>
+     * This method initiates unsubscription requests to the server and handles the responses.
+     * The callback will be invoked when all unsubscription requests are processed.
+     *
+     * @param {string|Array<string>} symbols - The symbol(s) to unsubscribe from
+     * @param {string|Array<string>} types - The data type(s) to unsubscribe from
+     * @param {Object|Function} optsOrCallback - Options object or callback function
+     * @param {Function} [callbackOrNothing] - Callback function if not provided as optsOrCallback
+     */
     Stream.prototype.unsubscribe = function unsubscribe(symbols, types, optsOrCallback, callbackOrNothing) {
         var _this4 = this;
@@ -1995,6 +2055,15 @@ var Stream = function () {
         }
     };
+    /**
+     * Closes this stream and releases resources.
+     * <p>
+     * This call will return immediately. The callback will be called once the stream is closed.
+     *
+     * @param {Function} callback - Called when the stream is closed
+     */
     Stream.prototype.close = function close(callback) {
         this.doClose(events.close({
             reason: "Manually closed",
@@ -2005,6 +2074,13 @@ var Stream = function () {
         }
     };
+    /**
+     * Determines if this stream is in a closed state.
+     *
+     * @returns {boolean} true if the stream is closed, false otherwise
+     */
     Stream.prototype.isClosed = function isClosed() {
         return this.conn == null;
     };
@@ -6815,6 +6891,10 @@ fmt.Formatter.prototype._fmttradeNotification = function (val) {
     s.append(val.alertable);
     s.sep();
     s.append(val.title);
+    s.sep();
+    s.append(val.eventSubtype);
+    s.sep();
+    s.append(JSON.stringify(val.discretionaryContent));
     return s.toString();
 };
@@ -15490,21 +15570,29 @@ exports.__esModule = true;
  */
 var LIBRARY_NAME = exports.LIBRARY_NAME = "JavaScript";
-var VERSION = exports.VERSION = "2.54.0";
+var VERSION = exports.VERSION = "2.55.0";
 /**
- * Streamer message api namespace.
+ * Streamer API namespace.
+ * <p>
+ * Provides the foundational classes and interfaces for interacting with the QuoteMedia streaming service.
+ * This includes message definitions, control operations, and market data types.
  * @namespace
  */
 var messages = exports.messages = {};
 /**
- * Streamer control message namespace. * @namespace
+ * Streamer control message namespace.
+ * <p>
+ * Contains message types for connection management, subscriptions, and administrative operations.
+ * @namespace
  */
 messages.control = {};
 /**
  * Streamer market data message namespace.
+ * <p>
+ * Contains message types for various market data events and information.
  * @namespace
  */
 messages.market = {};
@@ -16123,6 +16211,8 @@ messages.control.ReconnectResponse = function () {
 /**
  * Creates a connection response message.
+ * <p>
+ * This message is sent by the server when a connection is being closed, indicating the reason for closure.
  * @constructor
  */
 messages.control.ConnectionClose = function () {
@@ -16137,6 +16227,8 @@ messages.control.ConnectionClose = function () {
   /**
    * The connection close reason message.
+   * <p>
+   * A human-readable explanation of why the connection is being closed.
    * @type {string}
    * @see {@link messages.control.ResponseCodes}
    */