Added file export type defs

This commit is contained in:
Adam A. Zerella
2019-03-01 16:14:13 +11:00
parent 63ee6059e5
commit 64208f26fa
14 changed files with 103 additions and 1 deletions
+6
View File
@@ -0,0 +1,6 @@
/**
* Detects proper clamp min/max.
*/
declare function clamp(value: number, left: number, right: number): number;
export default clamp;
+6
View File
@@ -0,0 +1,6 @@
/**
* Get closest value out of a set.
*/
declare function closest(value: number, list: number[]): number;
export default closest;
-1
View File
@@ -2,7 +2,6 @@
// 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.
+7
View File
@@ -0,0 +1,7 @@
/**
* Check if one number is multiple of other
* Same as a % b === 0, but with precision check.
*/
declare function isMultiple(a: number, b: number, eps?: number): boolean;
export default isMultiple;
+6
View File
@@ -0,0 +1,6 @@
/**
* Return quadratic length of a vector.
*/
declare function len(a: number, b: number): number;
export default len;
+6
View File
@@ -0,0 +1,6 @@
/**
* Return value interpolated between x and y.
*/
declare function lerp(x: number, y: number, ratio: number): number;
export default lerp;
+6
View File
@@ -0,0 +1,6 @@
/**
* An enhanced mod-loop, like fmod — loops value within a frame.
*/
declare function mod(value: number, max: number, min?: number): number;
export default mod;
+23
View File
@@ -1,25 +1,48 @@
import * as mumath from "mumath";
import mumathClamp from "mumath/clamp";
import mumathClosest from "mumath/closest";
import mumathIsMultiple from "mumath/isMultiple";
import mumathLen from "mumath/len";
import mumathLerp from "mumath/lerp";
import mumathMod from "mumath/mod";
import mumathOrder from "mumath/order";
import mumathPrecision from "mumath/precision";
import mumathRound from "mumath/round";
import mumathScale from "mumath/scale";
import mumathWithin from "mumath/within";
mumath.clamp(1, 2, 3);
mumathClamp(1, 2, 3);
mumath.closest(5, [1, 7, 3, 6, 10]);
mumathClosest(5, [1, 7, 3, 6, 10]);
mumath.isMultiple(5, 10, 1.000074);
mumath.isMultiple(5, 10);
mumathIsMultiple(5, 10, 1.000074);
mumath.len(15, 1.0);
mumathLen(15, 1.0);
mumath.lerp(1, 2, 3);
mumathLerp(1, 2, 3);
mumath.mod(1, 2, 3);
mumath.mod(1, 2);
mumathMod(1, 2, 3);
mumath.order(5);
mumathOrder(5);
mumath.precision(5.0000001);
mumathPrecision(5.0000001);
mumath.round(0.3, 0.5);
mumathRound(0.3, 0.5);
mumath.scale(5.93, [1.0, 35, 10, 7.135]);
mumathScale(5.93, [1.0, 35, 10, 7.135]);
mumath.within(5, 1, 10);
mumathWithin(5, 1, 10);
+6
View File
@@ -0,0 +1,6 @@
/**
* Get order of magnitude for a number.
*/
declare function order(value: number): number;
export default order;
+6
View File
@@ -0,0 +1,6 @@
/**
* Get precision from float:
*/
declare function precision(value: number): number;
export default precision;
+6
View File
@@ -0,0 +1,6 @@
/**
* Rounds value to optional step.
*/
declare function round(value: number, step?: number): number;
export default round;
+8
View File
@@ -0,0 +1,8 @@
/**
* 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.
*/
declare function scale(value: number, list: number[]): number;
export default scale;
+11
View File
@@ -20,6 +20,17 @@
},
"files": [
"index.d.ts",
"clamp.d.ts",
"closest.d.ts",
"isMultiple.d.ts",
"len.d.ts",
"lerp.d.ts",
"mod.d.ts",
"order.d.ts",
"precision.d.ts",
"round.d.ts",
"scale.d.ts",
"within.d.ts",
"mumath-tests.ts"
]
}
+6
View File
@@ -0,0 +1,6 @@
/**
* Whether element is between left & right, including.
*/
declare function within(value: number, left: number, right: number): number;
export default within;