ws.connection.settings.js

/**
 * Constants required for establishing a WS connection and configuring the subscription.
 * @param {string} TBWebAdminWSApiUrl - TimeBase WebSockets api url.
 * @param {string} query - QQL query for requesting data.
 * @param {string} dateFrom - The date (only ISODateString) from which the data will be selected.
 * @param {boolean} live - Subscription mode.
 * @param {number} heartbeatInterval - Heartbeat interval.
 */
const WSConnectionSettings = {
  TBWebAdminWSApiUrl: 'ws://localhost:8099/ws/v0',
  query: 'select * from "warehouse-TRADES"',

  /**
   * The date from which the data will be selected.
   * If an earlier date than the start of the stream is specified, the data selection will begin from the start of the stream.
   * The data selection, in conjunction with dateFrom, is also influenced by the Subscription mode (specified below).
   */
  dateFrom: '1980-01-01T00:00:00.000Z',

  /**
   * Subscription mode.
   *
   * If live = true:
   * the subscription will return all data from dateFrom to the current moment and will remain active;
   * as new records appear in the database, they will be sent to the subscription;
   * if dateFrom is not specified, it will default to "Date Now."
   *
   * If live = false:
   * the subscription will return data from dateFrom to the current moment, and the subscription will then be closed;
   * if dateFrom is not specified, the data will be selected from the very beginning of the stream.
   */
  live: true,

  /**
   * A time parameter specifying the interval at which the heartbeat will be sent if `live = true`.
   * If not specified, the heartbeat will not be sent.
   */
  heartbeatInterval: 30000,
}

module.exports = WSConnectionSettings;