isThisWeek

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?

⚠️ Please note that this function is not present in the FP submodule as it uses Date.now() internally hence impure and can't be safely curried.

Usage

// CommonJS
var isThisWeek = require('date-fns/isThisWeek')

// ES 2015
import isThisWeek from 'date-fns/isThisWeek'

// ESM
import { isThisWeek } from 'date-fns'

Syntax

isThisWeek(date, [options])

Arguments

Name	Description
date	the date to check
options	the object with options
options.locale	the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
options.weekStartsOn	the index of the first day of the week (0 - Sunday)

Returns

Description
the date is in this week

Exceptions

Type	Description
TypeError	1 argument required
RangeError	options.weekStartsOn must be between 0 and 6

Examples

// If today is 25 September 2014, is 21 September 2014 in this week?
const result = isThisWeek(new Date(2014, 8, 21))
//=> true

// 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