Merge pull request #33142 from adamzerella/types/mumath

[mumath] Add mumath typing

types/mumath/index.d.ts

@@ -0,0 +1,63 @@
+// Type definitions for mumath 3.3
+// Project: https://github.com/dfcreative/mumath
+// Definitions by:  Adam Zerella <https://github.com/adamzerella>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 3.3
+
+/**
+ * Detects proper clamp min/max.
+ */
+export function clamp(value: number, left: number, right: number): number;
+
+/**
+ * Get closest value out of a set.
+ */
+export function closest(value: number, list: number[]): number;
+
+/**
+ * Check if one number is multiple of other
+ * Same as a % b === 0, but with precision check.
+ */
+export function isMultiple(a: number, b: number, eps?: number): boolean;
+
+/**
+ * Return quadratic length of a vector.
+ */
+export function len(a: number, b: number): number;
+
+/**
+ * Return value interpolated between x and y.
+ */
+export function lerp(x: number, y: number, ratio: number): number;
+
+/**
+ * An enhanced mod-loop, like fmod — loops value within a frame.
+ */
+export function mod(value: number, max: number, min?: number): number;
+
+/**
+ * Get order of magnitude for a number.
+ */
+export function order(value: number): number;
+
+/**
+ * Get precision from float:
+ */
+export function precision(value: number): number;
+
+/**
+ * Rounds value to optional step.
+ */
+export function round(value: number, step?: number): number;
+
+/**
+ * Get first scale out of a list of basic scales, aligned to the power. E. g.
+ * step(.37, [1, 2, 5]) → .5 step(456, [1, 2]) → 1000
+ * Similar to closest, but takes all possible powers of scales.
+ */
+export function scale(value: number, list: number[]): number;
+
+/**
+ * Whether element is between left & right, including.
+ */
+export function within(value: number, left: number, right: number): number;

types/mumath/mumath-tests.ts

@@ -0,0 +1,25 @@
+import * as mumath from "mumath";
+
+mumath.clamp(1, 2, 3);
+
+mumath.closest(5, [1, 7, 3, 6, 10]);
+
+mumath.isMultiple(5, 10, 1.000074);
+mumath.isMultiple(5, 10);
+
+mumath.len(15, 1.0);
+
+mumath.lerp(1, 2, 3);
+
+mumath.mod(1, 2, 3);
+mumath.mod(1, 2);
+
+mumath.order(5);
+
+mumath.precision(5.0000001);
+
+mumath.round(0.3, 0.5);
+
+mumath.scale(5.93, [1.0, 35, 10, 7.135]);
+
+mumath.within(5, 1, 10);

types/mumath/tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+      "module": "commonjs",
+      "lib": [
+        "es6"
+      ],
+      "noImplicitAny": true,
+      "noImplicitThis": true,
+      "strictNullChecks": true,
+      "strictFunctionTypes": true,
+      "baseUrl": "../",
+      "typeRoots": [
+        "../"
+      ],
+      "types": [
+
+      ],
+      "noEmit": true,
+      "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+      "index.d.ts",
+      "mumath-tests.ts"
+    ]
+}

types/mumath/tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "dtslint/dt.json"
+}