FIX,DOC: adjusted return types and fixed integer identification

fileOrder.json

@@ -5,7 +5,7 @@
             "alignment.js",
             "arrangement.js"
         ],
-        "size_sidings": [
+        "modifications": [
             "modificationSubChainMixins.js",
             "siding.js",
             "padding.js",

src/context/generalHelpers.js

@@ -66,8 +66,8 @@ class ObjectAccessObject {
  * @param {Function} fun
  * @returns {Object | Array<Object>}
  */
-function onSingleOrArray(singleOrArray, fun){
+function onSingleOrArray(singleOrArray, fun) {
-    if(singleOrArray instanceof Array){
+    if (singleOrArray instanceof Array) {
         return singleOrArray.map(fun);
     }
     return fun(singleOrArray);

src/modifier.js

@@ -34,7 +34,7 @@ class Modifier {
 
     /**
      * Sets the modifications for widht and height to 100%. 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
      */
     fillMaxSize(widthFraction = 1, heightFraction = 1) {
         return this.fillMaxWidth(widthFraction)
@@ -44,7 +44,7 @@ class Modifier {
     /**
      * Sets the modification for width to the given fraction of 1 (default 1 := 100%).
      * @param {number} fraction 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
     */
     fillMaxWidth(fraction = 1) {
         this._modifications["width"] = (100 * fraction) + "%";
@@ -55,7 +55,7 @@ class Modifier {
     /**
      * Sets the modification for height to the given fraction of 1 (default 1 := 100%).
      * @param {number} fraction 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
      */
     fillMaxHeight(fraction = 1) {
         this._modifications["height"] = (100 * fraction) + "%";
@@ -133,7 +133,7 @@ class Modifier {
             return this;
         } else {
             let modSub = new DimensionsChain(this);
-            if (modify instanceof Number && modify > 0) {
+            if (Number.isInteger(modify) && modify > 0) {
                 return modSub.all(modify).ensureModifier();
             }
             // case dimension is number but < 0 or dimensions == null or anything else
@@ -146,7 +146,7 @@ class Modifier {
      * Currently the padding will always be set 
      * to the most recent padding/padding. 
      * @param {Padding | number | undefined} modify as in modifiers
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | PaddingChain} this modifier object
      */
     padding(modify = null) {
         if (modify instanceof Sides && !(modify instanceof Padding)) {
@@ -177,7 +177,7 @@ class Modifier {
      *            it is recommended to use padding and to stick to that as often as possible. 
      *            Padding values take affect inside/within the element.
      * @param {Margin | number | undefined} modify 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | MarginChain} this modifier object
      */
     margin(modify = null) {
         if (modify instanceof Sides && !(modify instanceof Margin)) {
@@ -205,7 +205,7 @@ class Modifier {
      * If no color is given/specified the styling will be set to "inherit" 
      * and use the color setting from (one of) the parent.
      * @param {Color} color 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
      */
     background(color) {
         if (color) {
@@ -225,7 +225,7 @@ class Modifier {
      * If no color is given/specified the styling will be set to "inherit" 
      * and use the color setting from (one of) the parent.
      * @param {Color} color 
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
      */
     color(color) {
         this._modifications["color"] = (
@@ -246,7 +246,7 @@ class Modifier {
      * @todo finish second parameter "modifications" - logic
      * 
      * @param modifier The "new" Modifier
-     * @returns {Modifier} The "old/current" Modifier, 
+     * @returns {Modifier | ChainableModifier} The "old/current" Modifier, 
      * extended with the modifications of the given Modifier.
      */
     join(modifier, modifications = {}) {
@@ -271,7 +271,7 @@ class Modifier {
      * 
      * @param {string} key a css style rule
      * @param {string} value the corresponding value to the css style rule
-     * @returns {Modifier} this modifier object
+     * @returns {Modifier | ChainableModifier} this modifier object
      */
     setStyleRule(key, value) {
         this._modifications[key] = value;
@@ -281,7 +281,7 @@ class Modifier {
     /**
      * 
      * @param {StylePropertyMap} rulemap 
-     * @returns {Modifier}
+     * @returns {Modifier | ChainableModifier}
      */
     addStyleRuleMap(rulemap) {
         for (const ruleKey of Object.keys(rulemap)) {
@@ -293,7 +293,7 @@ class Modifier {
     /**
      * 
      * @param {string} key 
-     * @returns {Modifier} this modifier object 
+     * @returns {Modifier | ChainableModifier} this modifier object 
      */
     removeStyleRule(key) {
         this._removeMods.push(key);
@@ -341,7 +341,7 @@ class Modifier {
             return this;
         } else {
             let modSub = new BorderChain(this);
-            if (modify instanceof Number && modify > 0) {
+            if (Number.isInteger(modify) && modify > 0) {
                 return modSub.width(modify).ensureModifier();
             }
             return modSub;
@@ -373,7 +373,7 @@ class Modifier {
             return this;
         } else {
             let modSub = new ShapeChain(this);
-            if (modify instanceof Number && modify > 0) {
+            if (Number.isInteger(modify) && modify > 0) {
                 return modSub.all(modify).ensureModifier();
             }
             return modSub;
@@ -487,7 +487,7 @@ class ChainableModifier extends Modifier {
      * @returns {ChainableModifier | DimensionsChainedModifier} 
      */
     dimensions(modify = null) {
-        if (modify instanceof Dimensions || modify instanceof Number) {
+        if (modify instanceof Dimensions || Number.isInteger(modify)) {
             return super.dimensions(modify);
         }
         return new DimensionsChainedModifier(this);
@@ -523,12 +523,12 @@ class ChainableModifier extends Modifier {
      * @inheritdoc
      * 
      * @override
-     * @param {Shape | number | undefined} [Shape=null] shape
+     * @param {Shape | number | undefined} [modify=null] modify
      * @returns {ChainableModifier | ShapeChainedModifier} 
      */
-    clip(shape = null) {
+    clip(modify = null) {
-        if (shape instanceof Shape || shhaape instanceof Number) {
+        if (modify instanceof Shape || Number.isInteger(modify)) {
-            return super.clip(shape);
+            return super.clip(modify);
         }
         return new ShapeChainedModifier(this);
     }
@@ -539,12 +539,12 @@ class ChainableModifier extends Modifier {
      * @inheritdoc
      * 
      * @override
-     * @param {Border | number | undefined} [border=null] border
+     * @param {Border | number | undefined} [modify=null] modify
      * @returns {ChainableModifier | BorderChainedModifier} 
      */
-    border(border = null) {
+    border(modify = null) {
-        if (border instanceof Border || border instanceof Number) {
+        if (modify instanceof Border || Number.isInteger(modify)) {
-            return super.border(border);
+            return super.border(modify);
         }
         return new BorderChainedModifier(this);
     }

src/sizeSide/border.js

@@ -79,7 +79,7 @@ class Border extends Sides {
      * 
      * @param {string} key 
      * @param {*} value 
-     * @returns {this}
+     * @returns {typeof Border}
      */
     setOnDirections(key, value) {
         let orderedAttributes = this.getOrderedAttributes()
@@ -92,7 +92,7 @@ class Border extends Sides {
     /**
      * 
      * @param {number} width 
-     * @returns {this}
+     * @returns {typeof Border}
      */
     width(width) {
         this._fFirst._width = width;
@@ -105,7 +105,7 @@ class Border extends Sides {
     /**
      * 
      * @param {*} color 
-     * @returns {this}
+     * @returns {typeof Border}
     */
     color(color) {
         this._fFirst._color = color;
@@ -118,7 +118,7 @@ class Border extends Sides {
     /**
      * 
      * @param {Shape} shape 
-     * @returns {this}
+     * @returns {typeof Border}
      */
     shape(shape) {
         this._shape = shape;
@@ -128,7 +128,7 @@ class Border extends Sides {
     /**
      * Sets the border-style of all sides to the given. 
      * @param {LineStyles} lineStyle style of the border
-     * @returns {this}
+     * @returns {typeof Border}
      */
     setStyleAll(lineStyle) {
         this._fFirst._style = lineStyle;
@@ -142,7 +142,7 @@ class Border extends Sides {
      * 
      * @param {LineStyles} lineStyle 
      * @param {*} sidingRefSide 
-     * @returns {this}
+     * @returns {typeof Border}
      */
     setLineStyle(lineStyle, sidingRefSide) {
         this._sidingStyles.setBySidingRef(sidingRefSide, lineStyle)
@@ -152,7 +152,7 @@ class Border extends Sides {
     /**
      * 
      * @param {Map<SidingRefSides, LineStyles} refSideStyleMap 
-     * @returns {this}
+     * @returns {typeof Border}
      */
     setLineStyles(refSideStyleMap) {
         let rkeys = Object.keys(refSideStyleMap);

src/sizeSide/dimensions.js

@@ -26,7 +26,7 @@ class Dimensions extends DirectionUnitDependentAttribute {
     /**
      * Sets width (x) value of amount
      * @param {number} amount 
-     * @returns {this} this Dimensions Modifier
+     * @returns {typeof Dimensions} this Dimensions Modifier
      */
     width(amount) {
         this._fFirst = amount;
@@ -36,7 +36,7 @@ class Dimensions extends DirectionUnitDependentAttribute {
     /**
      * Sets height (y) value of amount
      * @param {number} amount 
-     * @returns {this} this Dimensions Modifier
+     * @returns {typeof Dimensions} this Dimensions Modifier
      */
     height(amount) {
         this._fSecond = amount;
@@ -46,15 +46,18 @@ class Dimensions extends DirectionUnitDependentAttribute {
     /**
      * 
      * @param {number} size 
-     * @returns {this}
+     * @returns {typeof Dimensions}
      */
     all(size) {
         return this.width(size).height(size);
     }
 
-
+    /**
+     * 
+     * @returns 
+     */
     getOrderedValues() {
-        return this.getOrderedValues().slice(2)
+        return super.getOrderedValues().slice(2)
     }
 
     /**

src/sizeSide/shapes.js

@@ -15,7 +15,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * 
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     topLeft(amount) {
         this._fFirst = amount;
@@ -24,7 +24,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * 
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     topRight(amount) {
         this._fSecond = amount;
@@ -33,7 +33,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * 
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     bottomLeft(amount) {
         this._fForth = amount;
@@ -42,7 +42,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * 
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     bottomRight(amount) {
         this._fThird = amount;
@@ -51,7 +51,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets the BottomLeft and TopRight corners
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     diagonalPositive(amount) {
         return this.bottomLeft(amount).topRight(amount);
@@ -59,7 +59,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets the TopLeft and BottomRight corners
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     diagonalNegative(amount) {
         return this.topLeft(amount).bottomRight(amount);
@@ -67,7 +67,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets both corners on the left side
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     left(amount) {
         return this.topLeft(amount).bottomLeft(amount);
@@ -75,7 +75,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets both corners on the right side
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     right(amount) {
         return this.topRight(amount).bottomRight(amount);
@@ -83,7 +83,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets both top corners
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     top(amount){
         return this.topLeft(amount).topRight(amount);
@@ -91,7 +91,7 @@ class Shape extends DirectionUnitDependentAttribute {
     /**
      * Sets both bottom corners
      * @param {number} amount 
-     * @returns {this}
+     * @returns {typeof Shape}
      */
     bottom(amount){
         return this.bottomLeft(amount).bottomRight(amount);

src/sizeSide/siding.js

@@ -43,7 +43,7 @@ class DirectionUnitDependentAttribute {
     /**
      * 
      * @param {Units} unit The unit of the amount or style
-     * @returns {this} this - Object
+     * @returns {typeof Sides} this - Object
      */
     setUnit(unit) {
         this._unit = unit;
@@ -72,7 +72,7 @@ class DirectionUnitDependentAttribute {
      * Mainly used by the setup of directions of subclasses.
      * @param {number} index [1,4]
      * @param {number} value 
-     * @returns {this} this
+     * @returns {typeof Sides} this
      */
     setByIndex(index, value) {
         switch (index) {
@@ -132,7 +132,7 @@ class DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for all directions.
      * @param {number} amount value to set for all directions
-     * @returns {this} this 
+     * @returns {typeof Sides} this 
      */
     all(amount) {
         this._fFirst = amount;
@@ -188,7 +188,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the left side.
      * @param {number} amount Sides for left
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     left(amount) {
         return this.setByIndex(1, amount);
@@ -197,7 +197,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the right side.
      * @param {number} amount Sides for right
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     right(amount) {
         return this.setByIndex(3, amount);
@@ -206,7 +206,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the top side.
      * @param {number} amount Sides for top
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     top(amount) {
         return this.setByIndex(2, amount);
@@ -215,7 +215,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the bottom side.
      * @param {number} amount Sides for bottom
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     bottom(amount) {
         return this.setByIndex(4, amount);
@@ -225,7 +225,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the horizontal sides (left and right).
      * @param {number} amount Sides for left and right.
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     horizontal(amount) {
         return this.left(amount).right(amount);
@@ -234,7 +234,7 @@ class Sides extends DirectionUnitDependentAttribute {
     /**
      * sets the amount-value for the vertical sides (left and right).
      * @param {number} amount Sides for top and bottom.
-     * @returns {this} this Sides Object
+     * @returns {typeof Sides} this Sides Object
      */
     vertical(amount) {
         return this.top(amount).bottom(amount);