feat(lib/utils.js): Add clamp function

Added function which clamps a numeric value to a range.
plroebuck · Nov 9, 2018 · 20083cb · 20083cb
1 parent 5d4ac5f
commit 20083cb
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/utils.js b/lib/utils.js
@@ -663,6 +663,17 @@ exports.isPromise = function isPromise(value) {
   return typeof value === 'object' && typeof value.then === 'function';
 };
 
+/**
+ * Clamps a numeric value to an inclusive range.
+ *
+ * @param {number} value - Value to be clamped.
+ * @param {numer[]} range - Two element array specifying [min, max] range.
+ * @returns {number} clamped value
+ */
+exports.clamp = function clamp(value, range) {
+  return Math.min(Math.max(value, range[0]), range[1]);
+};
+
 /**
  * It's a noop.
  * @api