PropertyObject.ts

  1. import { isString } from "@daybrush/utils";
  2. import { PropertyObjectState } from "./types";
  4. /**
  5. * Make string, array to PropertyObject for the dot product
  6. */
  7. class PropertyObject implements PropertyObjectState {
  8.     public value: any[];
  9.     public prefix: string = "";
  10.     public suffix: string = "";
  11.     public model: string = "";
  12.     public type: string = "";
  13.     public separator: string = ",";
  15.     /**
  16.       * @param - This value is in the array format.
  17.       * @param - options
  18.       * @example
  19.   var obj = new PropertyObject([100,100,100,0.5], {
  20.       "separator" : ",",
  21.       "prefix" : "rgba(",
  22.       "suffix" : ")"
  23.   });
  24.        */
  25.     constructor(value: string | any[], options?: Partial<PropertyObjectState>) {
  26.         options && this.setOptions(options);
  27.         this.value = isString(value) ? value.split(this.separator) : value;
  28.     }
  29.     public setOptions(newOptions: Partial<PropertyObjectState>) {
  30.         for (const name in newOptions) {
  31.             this[name as keyof PropertyObjectState] = newOptions[name as keyof PropertyObjectState];
  32.         }
  33.         return this;
  34.     }
  35.     /**
  36.       * the number of values.
  37.       * @example
  38.   const obj1 = new PropertyObject("1,2,3", ",");
  40.   console.log(obj1.length);
  41.   // 3
  42.        */
  43.     public size() {
  44.         return this.value.length;
  45.     }
  46.     /**
  47.       * retrieve one of values at the index
  48.       * @param {Number} index - index
  49.       * @return {Object} one of values at the index
  50.       * @example
  51.   const obj1 = new PropertyObject("1,2,3", ",");
  53.   console.log(obj1.get(0));
  54.   // 1
  55.        */
  56.     public get(index: number) {
  57.         return this.value[index];
  58.     }
  59.     /**
  60.       * Set the value at that index
  61.       * @param {Number} index - index
  62.       * @param {Object} value - text, a number, object to set
  63.       * @return {PropertyObject} An instance itself
  64.       * @example
  65.   const obj1 = new PropertyObject("1,2,3", ",");
  66.   obj1.set(0, 2);
  67.   console.log(obj1.toValue());
  68.   // 2,2,3
  69.        */
  70.     public set(index: number, value: any) {
  71.         this.value[index] = value;
  72.         return this;
  73.     }
  74.     /**
  75.       * create a copy of an instance itself.
  76.       * @return {PropertyObject} clone
  77.       * @example
  78.   const obj1 = new PropertyObject("1,2,3", ",");
  79.   const obj2 = obj1.clone();
  80.        */
  81.     public clone(): PropertyObject {
  82.         const {
  83.             separator,
  84.             prefix,
  85.             suffix,
  86.             model,
  87.             type,
  88.         } = this;
  89.         const arr = this.value.map(v => ((v instanceof PropertyObject) ? v.clone() : v));
  90.         return new PropertyObject(arr, {
  91.             separator,
  92.             prefix,
  93.             suffix,
  94.             model,
  95.             type,
  96.         });
  97.     }
  98.     /**
  99.       * Make Property Object to String
  100.       * @return {String} Make Property Object to String
  101.       * @example
  102.   //rgba(100, 100, 100, 0.5)
  103.   const obj4 = new PropertyObject([100,100,100,0.5], {
  104.       "separator" : ",",
  105.       "prefix" : "rgba(",
  106.       "suffix" : ")",
  107.   });
  108.   console.log(obj4.toValue());
  109.   // "rgba(100,100,100,0.5)"
  110.       */
  111.     public toValue(): string {
  112.         return this.prefix + this.join() + this.suffix;
  113.     }
  114.     /**
  115.       * Make Property Object's array to String
  116.       * @return {String} Join the elements of an array into a string
  117.       * @example
  118.       //rgba(100, 100, 100, 0.5)
  119.       var obj4 = new PropertyObject([100,100,100,0.5], {
  120.           "separator" : ",",
  121.           "prefix" : "rgba(",
  122.           "suffix" : ")"
  123.       });
  124.       obj4.join();  // =>   "100,100,100,0.5"
  125.        */
  126.     public join() {
  127.         return this.value.map(v => ((v instanceof PropertyObject) ? v.toValue() : v)).join(this.separator);
  128.     }
  129.     /**
  130.       * executes a provided function once per array element.
  131.       * @param {Function} callback - Function to execute for each element, taking three arguments
  132.       * @param {All} [callback.currentValue] The current element being processed in the array.
  133.       * @param {Number} [callback.index] The index of the current element being processed in the array.
  134.       * @param {Array} [callback.array] the array.
  135.       * @return {PropertyObject} An instance itself
  136.       * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach|MDN Array.forEach()} reference to MDN document.
  137.       * @example
  138.   //rgba(100, 100, 100, 0.5)
  139.   var obj4 = new PropertyObject([100,100,100,0.5], {
  140.       "separator" : ",",
  141.       "prefix" : "rgba(",
  142.       "suffix" : ")"
  143.   });
  145.   obj4.forEach(t => {
  146.       console.log(t);
  147.   });  // =>   "100,100,100,0.5"
  148.       */
  149.     public forEach(func: (value?: any, index?: number, array?: any[]) => void) {
  150.         this.value.forEach(func);
  151.         return this;
  152.     }
  153. }
  154. export default PropertyObject;