imagemagick-async/coordinates.js

An API for Image Magick commands.

let VALIDATE = require('./validate.js');

//-----------------------------------
// COORDINATES

class Coordinates {
  /**
   * @param {number} x  X-coordinate
   * @param {number} y  Y-coordinate
   */
  constructor(x, y) {
    this.x_ = x;
    this.y_ = y;
  }

  /** 
   * @returns {string} Returns a string representation of the coordinates as 'x,y'. 
   */
  String() {
    return `${this.x_},${this.y_}`;
  }

  /**
   * Create a Coordinates object given the specifiec x and y values.
   * @param {number} x X-coordinate
   * @param {number} y Y-coordinate
   * @returns {Coordinates} Returns a Coordinates object. If inputs are invalid, it returns null.
   */
  static Create(x, y) {
    if (
      VALIDATE.IsInteger(x) ||
      VALIDATE.IsInteger(y)
    )
      return null;

    return new Coordinates(x, y);
  }
}

//--------------------------------
// EXPORTS

exports.Create = Coordinates.Create;