parseWeekFromDateTime

Signature

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

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

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

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

Parameters

Parameter	Type	Description
value	string	ISO 8601 datetime string

Options

options

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

Returns

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

Examples

parseWeekFromDateTime("2024-01-01T12:00:00") // 1
parseWeekFromDateTime("2024-01-08T00:00:00") // 2
parseWeekFromDateTime("2024-01-01T00:00:00", { weekStartsOn: "sunday" }) // 1
parseWeekFromDateTime("invalid") // null

Source

plain/parse/parseWeekFromDateTime.ts