convertZonedToUnix

Signature

convertZonedToUnix(value: string, unit?: UnixUnit): number

import { convertZonedToUnix } from "@northguild/gmt/zoned/convert";

Convert an ISO 8601 zoned datetime string to a unix epoch value in milliseconds (default) or seconds.

• Uses Temporal.ZonedDateTime.toInstant to convert.
• Validates epoch unit (“seconds” | “milliseconds”).
• Returns null for invalid input.

Parameters

Parameter	Type	Description
value	string	zoned ISO 8601 datetime string
unit	``	optional: “seconds” | “milliseconds”

Returns

epoch number or null on invalid

Related types

• UnixUnit

Examples

convertZonedToUnix("2024-02-29T12:34:56.789+00:00[UTC]") // 1709200496789
convertZonedToUnix("2024-02-29T12:34:56.789+00:00[UTC]", "seconds") // 1709200496
convertZonedToUnix("invalid") // null

Source

zoned/convert/convertZonedToUnix.ts