smath 0.0.3 → 0.0.4

package/README.md

@@ -1,2 +1,5 @@
 # smath
-Small math function library
+Small math function library
+
+![NPM Version](https://img.shields.io/npm/v/smath)
+![NPM Downloads](https://img.shields.io/npm/dt/smath)

package/dist/Polate.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Polate = void 0;
+var Polate = (function () {
+    function Polate() {
+    }
+    Polate.normalize = function (n, min, max) {
+        if (min === max) {
+            return min;
+        }
+        return (n - min) / (max - min);
+    };
+    Polate.expand = function (n, min, max) {
+        return (max - min) * n + min;
+    };
+    Polate.translate = function (n, min1, max1, min2, max2) {
+        return this.expand(this.normalize(n, min1, max1), min2, max2);
+    };
+    return Polate;
+}());
+exports.Polate = Polate;

package/dist/SMath.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMath = void 0;
+var SMath = (function () {
+    function SMath() {
+    }
+    SMath.isNumber = function (n) {
+        return typeof n === 'number';
+    };
+    SMath.clamp = function (n, min, max) {
+        if (n < min) {
+            return min;
+        }
+        if (n > max) {
+            return max;
+        }
+        return n;
+    };
+    SMath.approx = function (a, b, epsilon) {
+        if (epsilon === void 0) { epsilon = 1e-6; }
+        return a - b < epsilon && b - a < epsilon;
+    };
+    return SMath;
+}());
+exports.SMath = SMath;

package/dist/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Interpolator"), exports);
+__exportStar(require("./Polate"), exports);
+__exportStar(require("./SMath"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smath",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Small math function library",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -17,12 +17,27 @@
     "docs": "rm -rf docs && typedoc src",
     "prepublishOnly": "npm run build && npm run types"
   },
-  "keywords": [],
+  "keywords": [
+    "small",
+    "math",
+    "function",
+    "library",
+    "simple",
+    "number",
+    "interpolate",
+    "interpolation",
+    "extrapolate",
+    "extrapolation"
+  ],
   "author": {
     "name": "Nicolas Ventura",
     "email": "smath@nicolasventura.com",
     "url": "https://nicolasventura.com/"
   },
+  "funding": {
+    "type": "paypal",
+    "url": "https://www.paypal.com/donate/?business=UM6EEKPW8GXA2&no_recurring=0&item_name=Open+source+development&currency_code=USD"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/nicfv/npm",

package/types/{Interpolator.d.ts → Polate.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Contains useful interpolation functions.
+ * Contains useful interpolation and extrapolation functions.
  */
-export declare class Interpolator {
+export declare class Polate {
     /**
      * Normalize the number `n` from the range `min, max` to the range `0, 1`
      * @param n The number to normalize

package/types/SMath.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Small Math function library
+ */
+export declare class SMath {
+    /**
+     * Determine if a value is numeric.
+     * @param n Any value to check
+     * @returns True if `n` is a number
+     */
+    static isNumber(n: any): boolean;
+    /**
+     * Clamp a number within a range.
+     * @param n The number to clamp
+     * @param min The minimum value of the range
+     * @param max The maximum value of the range
+     * @returns A clamped number
+     */
+    static clamp(n: number, min: number, max: number): number;
+    /**
+     * Check if two numbers are approximately equal with a maximum abolute error.
+     * @param a Any number
+     * @param b Any number
+     * @param epsilon Maximum absolute error
+     * @returns True if `a` is approximately `b`
+     */
+    static approx(a: number, b: number, epsilon?: number): boolean;
+}

package/types/index.d.ts

@@ -1 +1,2 @@
-export * from './Interpolator';
+export * from './Polate';
+export * from './SMath';

package/dist/Interpolator.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Interpolator = void 0;
-var Interpolator = (function () {
-    function Interpolator() {
-    }
-    Interpolator.normalize = function (n, min, max) {
-        if (min === max) {
-            return min;
-        }
-        return (n - min) / (max - min);
-    };
-    Interpolator.expand = function (n, min, max) {
-        return (max - min) * n + min;
-    };
-    Interpolator.translate = function (n, min1, max1, min2, max2) {
-        return this.expand(this.normalize(n, min1, max1), min2, max2);
-    };
-    return Interpolator;
-}());
-exports.Interpolator = Interpolator;