@ixfx/debug 0.38.0 → 0.39.0

package/README.md

@@ -0,0 +1 @@
+A few things useful for debugging.

package/dist/src/fps-counter.d.ts

@@ -1,2 +1,21 @@
+/**
+ * Calculates frames per second.
+ *
+ * Returns a function which needs to be called at the end of each frame.
+ *
+ * ```js
+ * const fps = fpsCounter();
+ *
+ * function loop() {
+ *  fps(); // Calculate fps
+ *  window.requestAnimationFrame(loop);
+ * }
+ *
+ * loop();
+ * ```
+ * @param autoDisplay If true (default), prints out the FPS to the console
+ * @param computeAfterFrames Calculates after this many frames. Higher numbers smoothes the value somewhat
+ * @returns
+ */
 export declare const fpsCounter: (autoDisplay?: boolean, computeAfterFrames?: number) => () => number;
 //# sourceMappingURL=fps-counter.d.ts.map

package/dist/src/fps-counter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fps-counter.d.ts","sourceRoot":"","sources":["../../src/fps-counter.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,GAAI,qBAAkB,EAAE,2BAAwB,iBAetE,CAAA"}
+{"version":3,"file":"fps-counter.d.ts","sourceRoot":"","sources":["../../src/fps-counter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,GAAI,qBAAkB,EAAE,2BAAwB,iBAetE,CAAA"}

package/dist/src/fps-counter.js

@@ -1,3 +1,22 @@
+/**
+ * Calculates frames per second.
+ *
+ * Returns a function which needs to be called at the end of each frame.
+ *
+ * ```js
+ * const fps = fpsCounter();
+ *
+ * function loop() {
+ *  fps(); // Calculate fps
+ *  window.requestAnimationFrame(loop);
+ * }
+ *
+ * loop();
+ * ```
+ * @param autoDisplay If true (default), prints out the FPS to the console
+ * @param computeAfterFrames Calculates after this many frames. Higher numbers smoothes the value somewhat
+ * @returns
+ */
 export const fpsCounter = (autoDisplay = true, computeAfterFrames = 500) => {
     let count = 0;
     let lastFps = 0;

package/dist/src/index.d.ts

@@ -1,5 +1,10 @@
 export * from './types.js';
 export * from './logger.js';
 export * from './fps-counter.js';
+/**
+ * Returns a string representation of an error
+ * @param ex
+ * @returns
+ */
 export declare const getErrorMessage: (ex: unknown) => string;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AAEjC,eAAO,MAAM,eAAe,GAAI,IAAI,OAAO,KAAG,MAM7C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AAEjC;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,IAAI,OAAO,KAAG,MAM7C,CAAC"}

package/dist/src/index.js

@@ -1,6 +1,11 @@
 export * from './types.js';
 export * from './logger.js';
 export * from './fps-counter.js';
+/**
+ * Returns a string representation of an error
+ * @param ex
+ * @returns
+ */
 export const getErrorMessage = (ex) => {
     if (typeof ex === `string`)
         return ex;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixfx/debug",
-  "version": "0.38.0",
+  "version": "0.39.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,