parseWeekFromDate

Signature

parseWeekFromDate(value: string, optionsArg?: { weekStartsOn?: "monday" | "sunday"; }): number

import { parseWeekFromDate } from "@northguild/gmt/plain/parse";

Return the week number for a given ISO 8601 date string.

• By default uses ISO weeks (Monday-based).
• Returns null for invalid input.

Parameters

Parameter	Type	Description
value	string	ISO date string

Options

options

Option	Type	Default
weekStartsOn?	"monday" | "sunday"	—

Returns

Week number (1-53) or null on invalid input

Examples

parseWeekFromDate("2024-01-01") // 1
parseWeekFromDate("2024-01-08") // 2
parseWeekFromDate("2024-12-31") // 1
parseWeekFromDate("2024-01-01", { weekStartsOn: "sunday" }) // 1
parseWeekFromDate("invalid") // null

Source

plain/parse/parseWeekFromDate.ts