differenceInCalendarWeeks

import { differenceInCalendarWeeks } from "https://esm.sh/v135/date-fns@3.6.0/index.d.mts";

@example

// How many calendar weeks are between 5 July 2014 and 20 July 2014?
const result = differenceInCalendarWeeks(
  new Date(2014, 6, 20),
  new Date(2014, 6, 5)
)
//=> 3

@example

// If the week starts on Monday,
// how many calendar weeks are between 5 July 2014 and 20 July 2014?
const result = differenceInCalendarWeeks(
  new Date(2014, 6, 20),
  new Date(2014, 6, 5),
  { weekStartsOn: 1 }
)
//=> 2

function differenceInCalendarWeeks<DateType extends Date>(

dateLeft: DateType | number | string,

dateRight: DateType | number | string,

options?: DifferenceInCalendarWeeksOptions,

): number;

differenceInCalendarWeeks<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: DifferenceInCalendarWeeksOptions): number

[src]

§Type Parameters

DateType extends Date

[src]

§Parameters

dateLeft: DateType | number | string

[src]

The later date

dateRight: DateType | number | string

[src]

The earlier date

options?: DifferenceInCalendarWeeksOptions optional

[src]

An object with options.

§Return Type

number

[src]

The number of calendar weeks