Issue #45 The Typescript definitions aren't up to date

- Attach namespaces BooleanOperations and Relations to Flatten namesapce - Fix several mismatches in typescript definition file - Release patch 1.2.8
alexbol99 · May 23, 2020 · 7323efb · 7323efb
1 parent a1fc359
commit 7323efb
Show file tree

Hide file tree

Showing 61 changed files with 348 additions and 241 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/dist/main.cjs.js b/dist/main.cjs.js
@@ -963,7 +963,7 @@ function removeNotRelevantNotIntersectedFaces(polygon, notIntersectedFaces, op,
     }
 }
 
-var boolean_op = /*#__PURE__*/Object.freeze({
+var BooleanOperations = /*#__PURE__*/Object.freeze({
     BOOLEAN_UNION: BOOLEAN_UNION,
     BOOLEAN_INTERSECT: BOOLEAN_INTERSECT,
     BOOLEAN_SUBTRACT: BOOLEAN_SUBTRACT,
@@ -2539,7 +2539,7 @@ function relatePolygon2Polygon(polygon1, polygon2) {
     return denim;
 }
 
-var relation = /*#__PURE__*/Object.freeze({
+var Relations = /*#__PURE__*/Object.freeze({
     equal: equal,
     intersect: intersect$1,
     touch: touch,
@@ -4427,7 +4427,7 @@ class Segment {
 
     /**
      * Sort given array of points from segment start to end, assuming all points lay on the segment
-     * @param {Point[]} array of points
+     * @param {Point[]} - array of points
      * @returns {Point[]} new array sorted
      */
     sortPoints(pts) {
@@ -6734,6 +6734,7 @@ class Polygon {
      * - array of shapes of type Segment or Arc <br/>
      * - array of points (Flatten.Point) <br/>
      * - array of numeric pairs which represent points <br/>
+     * - box or circle object <br/>
      * Alternatively, it is possible to use polygon.addFace method
      * @param {args} - array of shapes or array of arrays
      */
@@ -7901,9 +7902,12 @@ function inverse(shape, inversion_circle) {
  * Created by Alex Bol on 2/18/2017.
  */
 
+Flatten.BooleanOperations = BooleanOperations;
+Flatten.Relations = Relations;
+
 exports.Arc = Arc;
 exports.BOUNDARY = BOUNDARY;
-exports.BooleanOperations = boolean_op;
+exports.BooleanOperations = BooleanOperations;
 exports.Box = Box;
 exports.CCW = CCW;
 exports.CW = CW;
@@ -7922,7 +7926,7 @@ exports.PlanarSet = PlanarSet;
 exports.Point = Point;
 exports.Polygon = Polygon;
 exports.Ray = Ray;
-exports.Relations = relation;
+exports.Relations = Relations;
 exports.Segment = Segment;
 exports.Utils = Utils;
 exports.Vector = Vector;

diff --git a/dist/main.esm.js b/dist/main.esm.js
@@ -959,7 +959,7 @@ function removeNotRelevantNotIntersectedFaces(polygon, notIntersectedFaces, op,
     }
 }
 
-var boolean_op = /*#__PURE__*/Object.freeze({
+var BooleanOperations = /*#__PURE__*/Object.freeze({
     BOOLEAN_UNION: BOOLEAN_UNION,
     BOOLEAN_INTERSECT: BOOLEAN_INTERSECT,
     BOOLEAN_SUBTRACT: BOOLEAN_SUBTRACT,
@@ -2535,7 +2535,7 @@ function relatePolygon2Polygon(polygon1, polygon2) {
     return denim;
 }
 
-var relation = /*#__PURE__*/Object.freeze({
+var Relations = /*#__PURE__*/Object.freeze({
     equal: equal,
     intersect: intersect$1,
     touch: touch,
@@ -4423,7 +4423,7 @@ class Segment {
 
     /**
      * Sort given array of points from segment start to end, assuming all points lay on the segment
-     * @param {Point[]} array of points
+     * @param {Point[]} - array of points
      * @returns {Point[]} new array sorted
      */
     sortPoints(pts) {
@@ -6730,6 +6730,7 @@ class Polygon {
      * - array of shapes of type Segment or Arc <br/>
      * - array of points (Flatten.Point) <br/>
      * - array of numeric pairs which represent points <br/>
+     * - box or circle object <br/>
      * Alternatively, it is possible to use polygon.addFace method
      * @param {args} - array of shapes or array of arrays
      */
@@ -7897,5 +7898,8 @@ function inverse(shape, inversion_circle) {
  * Created by Alex Bol on 2/18/2017.
  */
 
+Flatten.BooleanOperations = BooleanOperations;
+Flatten.Relations = Relations;
+
 export default Flatten;
-export { Arc, BOUNDARY, boolean_op as BooleanOperations, Box, CCW, CW, Circle, Distance, Edge, errors as Errors, Face, INSIDE, Line, Matrix, Multiline, ORIENTATION, OUTSIDE, PlanarSet, Point, Polygon, Ray, relation as Relations, Segment, Utils, Vector, arc, box, circle, inverse, line, matrix, multiline, point, polygon, ray, ray_shoot, segment, vector };
+export { Arc, BOUNDARY, BooleanOperations, Box, CCW, CW, Circle, Distance, Edge, errors as Errors, Face, INSIDE, Line, Matrix, Multiline, ORIENTATION, OUTSIDE, PlanarSet, Point, Polygon, Ray, Relations, Segment, Utils, Vector, arc, box, circle, inverse, line, matrix, multiline, point, polygon, ray, ray_shoot, segment, vector };
diff --git a/dist/main.umd.js b/dist/main.umd.js
@@ -965,7 +965,7 @@
         }
     }
 
-    var boolean_op = /*#__PURE__*/Object.freeze({
+    var BooleanOperations = /*#__PURE__*/Object.freeze({
         BOOLEAN_UNION: BOOLEAN_UNION,
         BOOLEAN_INTERSECT: BOOLEAN_INTERSECT,
         BOOLEAN_SUBTRACT: BOOLEAN_SUBTRACT,
@@ -2541,7 +2541,7 @@
         return denim;
     }
 
-    var relation = /*#__PURE__*/Object.freeze({
+    var Relations = /*#__PURE__*/Object.freeze({
         equal: equal,
         intersect: intersect$1,
         touch: touch,
@@ -4429,7 +4429,7 @@
 
         /**
          * Sort given array of points from segment start to end, assuming all points lay on the segment
-         * @param {Point[]} array of points
+         * @param {Point[]} - array of points
          * @returns {Point[]} new array sorted
          */
         sortPoints(pts) {
@@ -6736,6 +6736,7 @@
          * - array of shapes of type Segment or Arc <br/>
          * - array of points (Flatten.Point) <br/>
          * - array of numeric pairs which represent points <br/>
+         * - box or circle object <br/>
          * Alternatively, it is possible to use polygon.addFace method
          * @param {args} - array of shapes or array of arrays
          */
@@ -7903,9 +7904,12 @@
      * Created by Alex Bol on 2/18/2017.
      */
 
+    Flatten.BooleanOperations = BooleanOperations;
+    Flatten.Relations = Relations;
+
     exports.Arc = Arc;
     exports.BOUNDARY = BOUNDARY;
-    exports.BooleanOperations = boolean_op;
+    exports.BooleanOperations = BooleanOperations;
     exports.Box = Box;
     exports.CCW = CCW;
     exports.CW = CW;
@@ -7924,7 +7928,7 @@
     exports.Point = Point;
     exports.Polygon = Polygon;
     exports.Ray = Ray;
-    exports.Relations = relation;
+    exports.Relations = Relations;
     exports.Segment = Segment;
     exports.Utils = Utils;
     exports.Vector = Vector;

diff --git a/docs/Arc.html b/docs/Arc.html
@@ -3392,7 +3392,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:56 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Box.html b/docs/Box.html
@@ -2391,7 +2391,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Circle.html b/docs/Circle.html
@@ -1554,7 +1554,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/CircularLinkedList.html b/docs/CircularLinkedList.html
@@ -663,7 +663,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/DE9IM.html b/docs/DE9IM.html
@@ -1503,7 +1503,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Edge.html b/docs/Edge.html
@@ -1660,7 +1660,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Errors.ILLEGAL_PARAMETERS.html b/docs/Errors.ILLEGAL_PARAMETERS.html
@@ -188,7 +188,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Errors.ZERO_DIVISION.html b/docs/Errors.ZERO_DIVISION.html
@@ -188,7 +188,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Errors.html b/docs/Errors.html
@@ -175,7 +175,7 @@ <h3 class="subsection-title">Classes</h3>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Face.html b/docs/Face.html
@@ -1935,7 +1935,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Line.html b/docs/Line.html
@@ -2434,7 +2434,7 @@ <h5>Parameters:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/LinkedList.html b/docs/LinkedList.html
@@ -939,7 +939,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Matrix.html b/docs/Matrix.html
@@ -1500,7 +1500,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Multiline.html b/docs/Multiline.html
@@ -1851,7 +1851,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/PlanarSet.html b/docs/PlanarSet.html
@@ -991,7 +991,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Point.html b/docs/Point.html
@@ -2353,7 +2353,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Wed Apr 29 2020 12:11:57 GMT+0300 (Israel Daylight Time) using the Minami theme.
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Sat May 23 2020 15:16:15 GMT+0300 (Israel Daylight Time) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>