figureone 0.15.10 → 1.0.0

package/types/js/tools/math.d.ts

@@ -0,0 +1,112 @@
+declare const roundNum: (value: number, precision?: number) => number;
+interface TypeRoundObject {
+    round?: (precision: number) => TypeRoundObject;
+}
+/**
+ * Rounds a number or numbers in an array
+ * @method
+ * @param {number | Array<number>} arrayOrValue - Value or array of values to be rounded
+ * @param {number} precision - Number of decimal places to round to
+ * @returns {number | Array<number>} Rounded value or array of values
+ * @group Math Tools
+ */
+declare function round<T extends number | TypeRoundObject | Array<number | TypeRoundObject> | [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+]>(arrayOrValue: T, precision?: number): T;
+declare function clipMag(value: number, zeroThreshold: number | null, maxValue: number | null): number;
+declare function clipValue(value: number, minValue: number | null, maxValue: number | null): number;
+declare const decelerate: (position: number, velocity: number, magDeceleration: number | null, time: number, zeroThreshold: number | null) => {
+    p: number;
+    v: number;
+};
+declare const linear: (percentTime: number, invert?: boolean) => number;
+declare function triangle(deltaTime?: number, frequency?: number, bias?: number, mag?: number, phaseOffset?: number): number;
+declare const easeinout: (percentTime: number, invert?: boolean) => number;
+declare function easeout(percentTime: number, invert?: boolean): number;
+declare function easein(percentTime: number, invert?: boolean): number;
+declare function sinusoid(deltaTime?: number, frequency?: number, bias?: number, mag?: number, phaseOffset?: number): number;
+declare function sinusoidAbs(deltaTime?: number, frequency?: number, bias?: number, mag?: number, phaseOffset?: number): number;
+/**
+ * Creates an array with a range of numbers
+ * @param start - Range start
+ * @param stop - Range stop
+ * @param step - Range step
+ * @returns {Array<number>} Range of numbers in an array
+ * @group Math Tools
+ */
+declare function range(start: number, stop: number, step?: number, precision?: number): number[];
+/**
+ * Return a -1 or 1 randomly
+ * @return {number} -1 or 1
+ * @group Math Tools
+ */
+declare function randSign(): number;
+/**
+ * Return a true or false randomly
+ * @return {boolean}
+ * @group Math Tools
+ */
+declare function randBool(): boolean;
+/**
+ * Return a random int.
+ *
+ * If a `max = null`, then the returned integer will be in the range of 0 to
+ * `minOrMax`.
+ *
+ * Otherwise the returned value is in the range of `minOrMax` to `max`.
+ *
+ * Use `sign` to also return a random sign (negative or positive);
+ *
+ * @return {number} random integer
+ * @group Math Tools
+ */
+declare function randInt(minOrMax: number, max?: number | null, sign?: boolean): number;
+/**
+ * Return a random number.
+ *
+ * If a `max = null`, then the returned number will be in the range of 0 to
+ * `minOrMax`.
+ *
+ * Otherwise the returned value is in the range of `minOrMax` to `max`.
+ *
+ * Use `sign` to also return a random sign (negative or positive);
+ *
+ * @return {number} random number
+ * @group Math Tools
+ */
+declare function rand(minOrMax: number, max?: number | null, plusOrMinus?: boolean): number;
+/**
+ * Get a random element from an array.
+ * @group Math Tools
+ */
+declare function randElement<T>(inputArray: Array<T>): T;
+/**
+ * Remove and return random element from an array.
+ * @group Math Tools
+ */
+declare function removeRandElement<T>(inputArray: Array<T>): T;
+/**
+ * Get a number of random elements from an array.
+ * @group Math Tools
+ */
+declare function randElements<T>(num: number, inputArray: Array<T>): Array<T>;
+declare function rand2D(minX: number, minY: number, maxX: number, maxY: number): {
+    x: number;
+    y: number;
+};
+export { round, roundNum, decelerate, easeinout, easeout, easein, sinusoid, sinusoidAbs, linear, triangle, clipMag, clipValue, range, randInt, rand, randElement, removeRandElement, randElements, rand2D, randSign, randBool, };