position-in-range/index.d.ts

Calculates the relative position of a number in the given range.

/** @module position-in-range
 */
declare module "position-in-range" {
    /**
     * @function
     * @param {number} lowerRangeNumber
     * @param {number} upperRangeNumber
     * @param {number} position
     * @returns {number} Relative position of given `position` within the range
     * @example
     * import positionInRange from "position-in-range"
     * positionInRange(2, 5,   2) //   0
     * positionInRange(2, 5,   5) //   1
     * positionInRange(2, 5, 3.5) // 0.5
     * positionInRange(2, 5,   8) //   2
     * positionInRange(2, 5,  -4) //  -2
     */
    export default function(lowerRangeNumber: number, upperRangeNumber: number, position: number): number;
}