aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/clamp/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/clamp/index.js')
-rw-r--r--node_modules/date-fns/esm/clamp/index.js35
1 files changed, 35 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/clamp/index.js b/node_modules/date-fns/esm/clamp/index.js
new file mode 100644
index 0000000..4e32b01
--- /dev/null
+++ b/node_modules/date-fns/esm/clamp/index.js
@@ -0,0 +1,35 @@
+import max from "../max/index.js";
+import min from "../min/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name clamp
+ * @category Interval Helpers
+ * @summary Return a date bounded by the start and the end of the given interval
+ *
+ * @description
+ * Clamps a date to the lower bound with the start of the interval and the upper
+ * bound with the end of the interval.
+ *
+ * - When the date is less than the start of the interval, the start is returned.
+ * - When the date is greater than the end of the interval, the end is returned.
+ * - Otherwise the date is returned.
+ *
+ * @example
+ * // What is Mar, 21, 2021 bounded to an interval starting at Mar, 22, 2021 and ending at Apr, 01, 2021
+ * const result = clamp(new Date(2021, 2, 21), {
+ * start: new Date(2021, 2, 22),
+ * end: new Date(2021, 3, 1),
+ * })
+ * //=> Mon Mar 22 2021 00:00:00
+ *
+ * @param {Date | Number} date - the date to be bounded
+ * @param {Interval} interval - the interval to bound to
+ * @returns {Date} the date bounded by the start and the end of the interval
+ * @throws {TypeError} 2 arguments required
+ */
+export default function clamp(date, _ref) {
+ var start = _ref.start,
+ end = _ref.end;
+ requiredArgs(2, arguments);
+ return min([max([date, start]), end]);
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage