aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/clamp/index.js
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2025-06-28 17:26:46 -0700
committerPinapelz <yukais@pinapelz.com>2025-06-28 17:43:56 -0700
commite4fa1e69e7ebfb627c7198fd1a9881e9327ec4d4 (patch)
tree06284a538a6008eca75051399e47db4e5d50301c /node_modules/date-fns/clamp/index.js
initial commit: scaffolding
Diffstat (limited to 'node_modules/date-fns/clamp/index.js')
-rw-r--r--node_modules/date-fns/clamp/index.js43
1 files changed, 43 insertions, 0 deletions
diff --git a/node_modules/date-fns/clamp/index.js b/node_modules/date-fns/clamp/index.js
new file mode 100644
index 0000000..8a004f1
--- /dev/null
+++ b/node_modules/date-fns/clamp/index.js
@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+ value: true
+});
+exports.default = clamp;
+var _index = _interopRequireDefault(require("../max/index.js"));
+var _index2 = _interopRequireDefault(require("../min/index.js"));
+var _index3 = _interopRequireDefault(require("../_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
+ */
+function clamp(date, _ref) {
+ var start = _ref.start,
+ end = _ref.end;
+ (0, _index3.default)(2, arguments);
+ return (0, _index2.default)([(0, _index.default)([date, start]), end]);
+}
+module.exports = exports.default; \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage