Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
40 lines
1.2 KiB
JavaScript
40 lines
1.2 KiB
JavaScript
"use strict";
|
|
exports.isThisWeek = isThisWeek;
|
|
var _index = require("./constructNow.js");
|
|
var _index2 = require("./isSameWeek.js");
|
|
|
|
/**
|
|
* The {@link isThisWeek} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name isThisWeek
|
|
* @category Week Helpers
|
|
* @summary Is the given date in the same week as the current date?
|
|
* @pure false
|
|
*
|
|
* @description
|
|
* Is the given date in the same week as the current date?
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @param date - The date to check
|
|
* @param options - The object with options
|
|
*
|
|
* @returns The date is in this week
|
|
*
|
|
* @example
|
|
* // If today is 25 September 2014, is 21 September 2014 in this week?
|
|
* const result = isThisWeek(new Date(2014, 8, 21))
|
|
* //=> true
|
|
*
|
|
* @example
|
|
* // If today is 25 September 2014 and week starts with Monday
|
|
* // is 21 September 2014 in this week?
|
|
* const result = isThisWeek(new Date(2014, 8, 21), { weekStartsOn: 1 })
|
|
* //=> false
|
|
*/
|
|
function isThisWeek(date, options) {
|
|
return (0, _index2.isSameWeek)(date, (0, _index.constructNow)(date), options);
|
|
}
|