31 lines
982 B
JavaScript
31 lines
982 B
JavaScript
var isSameWeek = require('../is_same_week/index.js')
|
|
|
|
/**
|
|
* @category Week Helpers
|
|
* @summary Is the given date in the same week as the current date?
|
|
*
|
|
* @description
|
|
* Is the given date in the same week as the current date?
|
|
*
|
|
* @param {Date|String|Number} date - the date to check
|
|
* @param {Object} [options] - the object with options
|
|
* @param {Number} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
|
|
* @returns {Boolean} the date is in this week
|
|
*
|
|
* @example
|
|
* // If today is 25 September 2014, is 21 September 2014 in this week?
|
|
* var 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?
|
|
* var result = isThisWeek(new Date(2014, 8, 21), {weekStartsOn: 1})
|
|
* //=> false
|
|
*/
|
|
function isThisWeek (dirtyDate, dirtyOptions) {
|
|
return isSameWeek(new Date(), dirtyDate, dirtyOptions)
|
|
}
|
|
|
|
module.exports = isThisWeek
|