kucoin-api-client/src/webSocket/messageSequenceValidator.mjs

KuCoin API client for REST and WebSocket API

export function createMessageSequenceValidator() {
  /**
   * Validates if a data message is in the correct sequential order and provides the expected sequence
   * if not in order.
   *
   * @param {object} data - The data object containing the message to be checked.
   * @returns {object} An object containing a boolean flag 'isValid' and 'expectedSequence' if not valid.
   *
   * @example
   * const { isMessageSequential } = createDataSequenceValidator();
   * const result = isMessageSequential({ message: "Some data message" });
   * if (result.isValid) {
   *   console.log("Sequence is valid.");
   * } else {
   *   console.log(`Sequence is not valid. Expected: ${result.expectedSequence}`);
   * }
   */
  function isMessageSequential(data) {
    // Assuming some logic here to determine if the message is sequential
    // and what the expected sequence should be if it's not.
    const isValid = true; // Placeholder for actual validation logic
    if (isValid) {
      return { isValid };
    } else {
      const expectedSequence = "Expected sequence details here"; // Placeholder
      return { isValid, expectedSequence };
    }
  }

  function reset() {
  }

  return { isMessageSequential, reset }
}