parseWeekFromZoned

Signature

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

import { parseWeekFromZoned } from "@northguild/gmt/zoned/parse";

Return the week of the year (1-53) for a given ISO 8601 zoned datetime string.

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

Parameters

Parameter	Type	Description
value	string	ISO zoned datetime string

Options

options

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

Returns

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

Examples

parseWeekFromZoned("2024-01-01T14:30:45.123+00:00[UTC]") // 1
parseWeekFromZoned("2024-01-08T14:30:45.123+00:00[UTC]") // 2
parseWeekFromZoned("invalid") // null

Source

zoned/parse/parseWeekFromZoned.ts