feat: add set fps jsdoc

drawcall · Jan 26, 2025 · 3942c93 · 3942c93
1 parent 37dfd4d
commit 3942c93
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 11 deletions.
diff --git a/build/proton.d.ts b/build/proton.d.ts
@@ -147,8 +147,16 @@ declare class Proton$1 {
     integrator: Integration;
     _fps: string;
     _interval: number;
-    set fps(fps: string);
-    get fps(): string;
+    /**
+     * Sets the frames per second (FPS) for the Proton system.
+     * @param {number|string} fps - The desired FPS. Use "auto" for default behavior, or a number for a specific FPS.
+     */
+    set fps(fps: number | string);
+    /**
+     * Gets the current frames per second (FPS) setting.
+     * @returns {number|string} The current FPS setting. Returns "auto" if set to default, or a number representing the specific FPS.
+     */
+    get fps(): number | string;
     /**
      * add a type of Renderer
      *

diff --git a/build/proton.js b/build/proton.js
diff --git a/build/proton.min.js b/build/proton.min.js
diff --git a/build/proton.min.js.map b/build/proton.min.js.map
diff --git a/build/proton.web.js b/build/proton.web.js
diff --git a/build/proton.web.min.js b/build/proton.web.min.js
diff --git a/build/proton.web.min.js.map b/build/proton.web.min.js.map
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "proton-engine",
-  "version": "7.1.0",
+  "version": "7.1.1",
   "description": "Proton is a simple and powerful javascript particle animation engine.",
   "keywords": [
     "particle",

diff --git a/src/core/Proton.js b/src/core/Proton.js
@@ -62,11 +62,19 @@ export default class Proton {
     this._interval = Proton.DEFAULT_INTERVAL;
   }
 
+  /**
+   * Sets the frames per second (FPS) for the Proton system.
+   * @param {number|string} fps - The desired FPS. Use "auto" for default behavior, or a number for a specific FPS.
+   */
   set fps(fps) {
     this._fps = fps;
     this._interval = fps === "auto" ? Proton.DEFAULT_INTERVAL : MathUtil.floor(1 / fps, 7);
   }
 
+  /**
+   * Gets the current frames per second (FPS) setting.
+   * @returns {number|string} The current FPS setting. Returns "auto" if set to default, or a number representing the specific FPS.
+   */
   get fps() {
     return this._fps;
   }