uttori-utilities/src/operator.js

A set of helper utilities for Uttoti components.

/**
 * To distinguish between the binary minus and unary.
 */
const OPERATOR_UNARY_MINUS = Symbol('-');

/**
 * Number of operands in a unary operation.
 */
const OPERATOR_TYPE_UNARY = 1;

/**
 * Number of operands in a binary operation.
 */
const OPERATOR_TYPE_BINARY = 2;

/**
 * Number of operands in a ternary operation.
 */
const OPERATOR_TYPE_TERNARY = 3;

/**
 * A wrapper class around operators to distinguish them from regular tokens.
 *
 * @property {*} value - The value.
 * @property {*} type - The type of operator.
 * @property {number} precedence - Priority to sort the operators with.
 * @example <caption>Init TokenizeThis</caption>
 * const op = new Operator(value, type, precedence);
 * @class
 */
class Operator {
  /**
   * Creates an instance of Operator.
   *
   * @param {*} value - The value.
   * @param {*} type - The type of operator.
   * @param {number} precedence - Priority to sort the operators with.
   * @class
   */
  constructor(value, type, precedence) {
    this.value = value;
    this.type = type;
    this.precedence = precedence;
  }

  /**
   * Returns the value as is for JSON.
   *
   * @returns {*} value.
   */
  toJSON() {
    return this.value;
  }

  /**
   * Returns the value as its string format.
   *
   * @returns {string} String representation of value.
   */
  toString() {
    return `${this.value}`;
  }

  /**
   * Returns a type for a given string.
   *
   * @param {string} type - The type to lookup.
   * @returns {*} Either number of parameters or Unary Minus Symbol.
   * @static
   */

  static type(type) {
    switch (type) {
      case 'unary':
        return OPERATOR_TYPE_UNARY;
      case 'binary':
        return OPERATOR_TYPE_BINARY;
      case 'ternary':
        return OPERATOR_TYPE_TERNARY;
      case 'unary-minus':
        return OPERATOR_UNARY_MINUS;
      default:
        throw new Error(`Unknown Operator Type: ${type}`);
    }
  }
}

module.exports = Operator;