Include translate utility

Author: Kubit

src/utils/translateValue/__tests__/translateValue.test.ts

@@ -0,0 +1,47 @@
+import { translateValue } from '../translateValue';
+
+describe('translateValue', () => {
+  it('should translate a value from one range to another', () => {
+    const result = translateValue({
+      inputMin: 0,
+      inputMax: 100,
+      outputMin: 0,
+      outputMax: 1,
+      value: 50,
+    });
+    expect(result).toBe(0.5);
+  });
+
+  it('should translate a value from one range to another with different ranges', () => {
+    const result = translateValue({
+      inputMin: 0,
+      inputMax: 200,
+      outputMin: 0,
+      outputMax: 2,
+      value: 100,
+    });
+    expect(result).toBe(1);
+  });
+
+  it('should constrain the output value within the output range', () => {
+    const result = translateValue({
+      inputMin: 0,
+      inputMax: 100,
+      outputMin: 0,
+      outputMax: 1,
+      value: 150,
+    });
+    expect(result).toBe(1);
+  });
+
+  it('should handle negative input and output ranges', () => {
+    const result = translateValue({
+      inputMin: -100,
+      inputMax: 100,
+      outputMin: -1,
+      outputMax: 1,
+      value: 0,
+    });
+    expect(result).toBe(0);
+  });
+});

src/utils/translateValue/translateValue.ts

@@ -0,0 +1,45 @@
+/**
+ * Translates a value from one range to another.
+ * This is useful in scenarios where you need to map a value from one scale
+ * to another, such as converting a temperature from Celsius to Fahrenheit,
+ * or mapping a slider value to a different range.
+ *
+ * @param {Object} params - The parameters for the translation.
+ * @param {number} params.inputMin - The minimum value of the input range.
+ * @param {number} params.inputMax - The maximum value of the input range.
+ * @param {number} params.outputMin - The minimum value of the output range.
+ * @param {number} params.outputMax - The maximum value of the output range.
+ * @param {number} params.value - The value to be translated.
+ * @returns {number} - The translated value, constrained within the output range.
+ *
+ *  * @example
+ * // Translates 50 from the range [0, 100] to the range [5, 10]
+ * const output = translateValue({inputMin: 0, inputMax: 100, outputMin: 5, outputMax: 10, value: 50});
+ * console.log(output); // 7.5
+ */
+export const translateValue = ({
+  inputMin,
+  inputMax,
+  outputMin,
+  outputMax,
+  value,
+}: {
+  inputMin: number;
+  inputMax: number;
+  outputMin: number;
+  outputMax: number;
+  value: number;
+}): number => {
+  // Calculate Input Range
+  const inputRange = inputMax - inputMin;
+  // Calculate Output Range
+  const outputRange = outputMax - outputMin;
+  // Scale the Input Value
+  const scaledInputValue = (value - inputMin) / inputRange;
+  // Translate to Output Range
+  let outputValue = outputMin + scaledInputValue * outputRange;
+  // Constrain the Output Value
+  outputValue = Math.min(outputMax, Math.max(outputMin, outputValue));
+
+  return outputValue;
+};