parseDayOfWeekFromUtc

Signature

parseDayOfWeekFromUtc(value: string, options?: { timeZone?: string; }): number | null

Return the day of week (1-7) from a UTC datetime string.

• Monday=1 through Sunday=7.
• Returns null for invalid input.

Parameters

Parameter	Type	Description
value	string	ISO UTC datetime string (e.g., “2024-03-17T14:30:45Z”)

Options

options

The time zone the value is read in

Option	Type	Default	Description
timeZone?	string	"UTC"	The time zone the wall-clock fields are read in: an IANA name, a UTC offset (a time zone identifier such as +05:30, +0530 or -08, or a stored offset ±HH:MM[:SS], what getTimeZoneOffset returns), or "local" for the system time zone. An unknown zone returns null.

Returns

Day of week (1-7) or null on invalid input

Examples

import { parseDayOfWeekFromUtc } from "@northguild/gmt/utc/parse";

parseDayOfWeekFromUtc("2024-03-17T14:30:45Z") // 7

value

output

 

Source

utc/parse/parseDayOfWeekFromUtc.ts