parseWeekFromUnix

Signature

parseWeekFromUnix(value: string | number, options?: { epochUnit?: UnixUnit; timeZone?: string; weekStartsOn?: "monday" | "sunday"; }): number

import { parseWeekFromUnix } from "@northguild/gmt/unix/parse";

Return the week number from a unix epoch value.

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

Parameters

Parameter	Type	Description
value	string | number	unix epoch in milliseconds or seconds (number or string)

Options

options

Option	Type	Default
epochUnit?	UnixUnit	—
timeZone?	string	—
weekStartsOn?	"monday" | "sunday"	—

Returns

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

Related types

• UnixUnit

Examples

parseWeekFromUnix(1704067200000) // 1
parseWeekFromUnix(1704067200000, { weekStartsOn: "sunday" }) // 1
parseWeekFromUnix(-86400, { epochUnit: "seconds" }) // 1

Source

unix/parse/parseWeekFromUnix.ts