feat: minor improve types

Prozi · Mar 1, 2024 · 8d588d0 · 8d588d0
1 parent 67089c0
commit 8d588d0
Show file tree

Hide file tree

Showing 28 changed files with 72 additions and 75 deletions.
diff --git a/dist/demo/demo.js b/dist/demo/demo.js
@@ -1416,7 +1416,7 @@ class System extends base_system_1.BaseSystem {
     /**
      * check all bodies collisions with callback
      */
-    checkAll(callback, response = this.response) {
+    checkAll(callback = utils_1.returnTrue, response = this.response) {
         const checkOne = (body) => {
             return this.checkOne(body, callback, response);
         };

diff --git a/dist/model.d.ts b/dist/model.d.ts
@@ -9,7 +9,7 @@ import { Polygon } from "./bodies/polygon";
 import { BaseSystem } from "./base-system";
 export { Polygon as DecompPolygon, Point as DecompPoint } from "poly-decomp";
 export { RBush, BBox, Response, SATVector, SATPolygon, SATCircle };
-export type CheckCollisionCallback = (response: Response) => void | boolean;
+export type CollisionCallback = (response: Response) => boolean | void;
 /**
  * types
  */

diff --git a/dist/system.d.ts b/dist/system.d.ts
@@ -1,7 +1,7 @@
 /// <reference types="sat" />
 import { BaseSystem } from "./base-system";
 import { Line } from "./bodies/line";
-import { RaycastHit, Response, Vector, Body, CheckCollisionCallback } from "./model";
+import { RaycastHit, Response, Vector, Body, CollisionCallback } from "./model";
 /**
  * collision system
  */
@@ -25,11 +25,11 @@ export declare class System<TBody extends Body = Body> extends BaseSystem<TBody>
     /**
      * check one body collisions with callback
      */
-    checkOne(body: TBody, callback?: CheckCollisionCallback, response?: Response): boolean;
+    checkOne(body: TBody, callback?: CollisionCallback, response?: Response): boolean;
     /**
      * check all bodies collisions with callback
      */
-    checkAll(callback: (response: Response) => void | boolean, response?: Response): boolean;
+    checkAll(callback?: CollisionCallback, response?: Response): boolean;
     /**
      * check do 2 objects collide
      */

diff --git a/dist/system.js b/dist/system.js
@@ -63,7 +63,7 @@ class System extends base_system_1.BaseSystem {
     /**
      * check all bodies collisions with callback
      */
-    checkAll(callback, response = this.response) {
+    checkAll(callback = utils_1.returnTrue, response = this.response) {
         const checkOne = (body) => {
             return this.checkOne(body, callback, response);
         };

diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/System.html b/docs/classes/System.html
diff --git a/docs/demo/demo.js b/docs/demo/demo.js
@@ -1416,7 +1416,7 @@ class System extends base_system_1.BaseSystem {
     /**
      * check all bodies collisions with callback
      */
-    checkAll(callback, response = this.response) {
+    checkAll(callback = utils_1.returnTrue, response = this.response) {
         const checkOne = (body) => {
             return this.checkOne(body, callback, response);
         };

diff --git a/docs/enums/BodyType.html b/docs/enums/BodyType.html
diff --git a/docs/interfaces/BodyOptions.html b/docs/interfaces/BodyOptions.html
diff --git a/docs/interfaces/BodyProps.html b/docs/interfaces/BodyProps.html
diff --git a/docs/interfaces/ChildrenData.html b/docs/interfaces/ChildrenData.html
diff --git a/docs/interfaces/Data.html b/docs/interfaces/Data.html
diff --git a/docs/interfaces/GetAABBAsBox.html b/docs/interfaces/GetAABBAsBox.html
diff --git a/docs/interfaces/PotentialVector.html b/docs/interfaces/PotentialVector.html
diff --git a/docs/interfaces/RaycastHit.html b/docs/interfaces/RaycastHit.html
diff --git a/docs/interfaces/Vector.html b/docs/interfaces/Vector.html
diff --git a/docs/modules.html b/docs/modules.html
@@ -21,7 +21,7 @@
 <a href="interfaces/RaycastHit.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Raycast<wbr/>Hit</span></a>
 <a href="interfaces/Vector.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Vector</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="types/Body.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Body</span></a>
-<a href="types/CheckCollisionCallback.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Check<wbr/>Collision<wbr/>Callback</span></a>
+<a href="types/CollisionCallback.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Collision<wbr/>Callback</span></a>
 <a href="types/DecompPoint.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Decomp<wbr/>Point</span></a>
 <a href="types/DecompPolygon.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Decomp<wbr/>Polygon</span></a>
 <a href="types/InTest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>In<wbr/>Test</span></a>

diff --git a/docs/types/Body.html b/docs/types/Body.html
diff --git a/docs/types/CheckCollisionCallback.html b/docs/types/CheckCollisionCallback.html
diff --git a/docs/types/CollisionCallback.html b/docs/types/CollisionCallback.html
diff --git a/docs/types/InTest.html b/docs/types/InTest.html
diff --git a/docs/types/Leaf.html b/docs/types/Leaf.html
diff --git a/docs/types/SATTest.html b/docs/types/SATTest.html
diff --git a/docs/types/TraverseFunction.html b/docs/types/TraverseFunction.html
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "detect-collisions",
-  "version": "9.3.3",
+  "version": "9.4.0",
   "description": "detecting collisions between bodies: Points, Lines, Boxes, Polygons (Concave too), Ellipses and Circles. Also RayCasting. All bodies can have offset, rotation, scale, bounding box padding, can be static (non moving) or be trigger bodies (non colliding).",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/src/model.ts b/src/model.ts
@@ -12,13 +12,12 @@ import { Ellipse } from "./bodies/ellipse";
 import { Line } from "./bodies/line";
 import { Point } from "./bodies/point";
 import { Polygon } from "./bodies/polygon";
-import { System } from "./system";
 import { BaseSystem } from "./base-system";
 
 export { Polygon as DecompPolygon, Point as DecompPoint } from "poly-decomp";
 export { RBush, BBox, Response, SATVector, SATPolygon, SATCircle };
 
-export type CheckCollisionCallback = (response: Response) => void | boolean;
+export type CollisionCallback = (response: Response) => boolean | void;
 
 /**
  * types

diff --git a/src/system.ts b/src/system.ts
@@ -1,15 +1,13 @@
 import { BaseSystem } from "./base-system";
 import { Line } from "./bodies/line";
 import {
-  Leaf,
   RaycastHit,
   Response,
   SATVector,
-  SATTest,
   Vector,
   Body,
   BodyType,
-  CheckCollisionCallback,
+  CollisionCallback,
 } from "./model";
 import {
   distance,
@@ -74,7 +72,7 @@ export class System<TBody extends Body = Body> extends BaseSystem<TBody> {
    */
   checkOne(
     body: TBody,
-    callback: CheckCollisionCallback = returnTrue,
+    callback: CollisionCallback = returnTrue,
     response = this.response,
   ): boolean {
     // no need to check static body collision
@@ -99,7 +97,7 @@ export class System<TBody extends Body = Body> extends BaseSystem<TBody> {
    * check all bodies collisions with callback
    */
   checkAll(
-    callback: (response: Response) => void | boolean,
+    callback: CollisionCallback = returnTrue,
     response = this.response,
   ): boolean {
     const checkOne = (body: TBody) => {