Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

getWeekYear

import { getWeekYear } from "https://esm.sh/v135/date-fns@3.6.0/index.d.mts";
@example
// Which week numbering year is 26 December 2004 with the default settings?
const result = getWeekYear(new Date(2004, 11, 26))
//=> 2005
@example
// Which week numbering year is 26 December 2004 if week starts on Saturday?
const result = getWeekYear(new Date(2004, 11, 26), { weekStartsOn: 6 })
//=> 2004
@example
// Which week numbering year is 26 December 2004 if the first week contains 4 January?
const result = getWeekYear(new Date(2004, 11, 26), { firstWeekContainsDate: 4 })
//=> 2004
function getWeekYear<DateType extends Date>(date: DateType | number | string, options?: GetWeekYearOptions): number;
§
getWeekYear<DateType extends Date>(date: DateType | number | string, options?: GetWeekYearOptions): number
[src]

§Type Parameters

§
DateType extends Date
[src]

§Parameters

§
date: DateType | number | string
[src]
  • The given date
§
options?: GetWeekYearOptions optional
[src]
  • An object with options.

§Return Type

§
number
[src]

The local week-numbering year