Instant

Ƭ Instant: Format["YYYY-MM-DDThh:mm-ss[.sss]Z"] & string

An Iso.Instant is a single point in time (called "exact time"), with a precision in milliseconds. No time zone is present. As such Iso.Instant has no concept of days, months or even hours.

For convenience of interoperability, instants are represented as an ISO8601 string in Zulu time (UTC). The format looks like 1970-01-01T00:00:00.000Z.

If you have a legacy Date instance, you can use its toISOString() method to convert to an Iso.Instant.

Since Iso.Instant doesn't contain any information about time zones, a Iso.TimeZone is needed in order to convert it into a Iso.DateTime (and from there into any of the other Iso types.)

Like Unix time, Instant ignores leap seconds.

Defined in

iso-types.ts:39

now

▸ now(): Instant

This method gets the current exact system time, without regard to time zone. This is a good way to get a timestamp for an event, for example. It works like the old-style JavaScript Date.now().

Returns

Instant

an Iso.Instant string representing the current system time.

Defined in

types/IInstantFns.ts:13

---

fromEpochMilliseconds

▸ fromEpochMilliseconds(epochMilliseconds): Instant

Parameters

Name	Type
epochMilliseconds	number

Returns

Instant

Defined in

types/IInstantFns.ts:14

---

isValid

▸ isValid(instant): instant is Instant

Parameters

Name	Type
instant	unknown

Returns

instant is Instant

Defined in

types/IInstantFns.ts:15

---

assertIsValid

▸ assertIsValid(instant): asserts instant is Instant

Parameters

Name	Type
instant	unknown

Returns

asserts instant is Instant

Defined in

types/IInstantFns.ts:16

---

getEpochSeconds

▸ getEpochSeconds(instant): number

Parameters

Name	Type
instant	Instant

Returns

number

Defined in

types/IInstantFns.ts:17

---

getEpochMilliseconds

▸ getEpochMilliseconds(instant): number

Parameters

Name	Type
instant	Instant

Returns

number

Defined in

types/IInstantFns.ts:18

---

add

▸ add(instant, temporalDurationLike): Instant

Here is a comment!

Parameters

Name	Type
instant	Instant
temporalDurationLike	Duration | { years?: number ; months?: number ; weeks?: number ; days?: number ; hours?: number ; minutes?: number ; seconds?: number ; milliseconds?: number }

Returns

Instant

Defined in

types/IInstantFns.ts:24

---

subtract

▸ subtract(instant, temporalDurationLike): Instant

Parameters

Name	Type
instant	Instant
temporalDurationLike	Duration | { years?: number ; months?: number ; weeks?: number ; days?: number ; hours?: number ; minutes?: number ; seconds?: number ; milliseconds?: number }

Returns

Instant

Defined in

types/IInstantFns.ts:39

---

until

▸ until(from, until, options?): Duration

Parameters

Name	Type
from	Instant
until	Instant
options?	Object
options.largestUnit?	TemporalSingularUnit | TemporalPluralUnit | "auto"
options.smallestUnit?	TemporalSingularUnit | TemporalPluralUnit
options.roundingIncrement?	number
options.roundingMode?	TemporalRoundingMode

Returns

Duration

Defined in

types/IInstantFns.ts:54

---

since

▸ since(to, since, options?): Duration

Parameters

Name	Type
to	Instant
since	Instant
options?	Object
options.largestUnit?	TemporalSingularUnit | TemporalPluralUnit | "auto"
options.smallestUnit?	TemporalSingularUnit | TemporalPluralUnit
options.roundingIncrement?	number
options.roundingMode?	TemporalRoundingMode

Returns

Duration

Defined in

types/IInstantFns.ts:64

---

round

▸ round(instant, options): Instant

Parameters

Name	Type
instant	Instant
options	Object
options.smallestUnit?	TemporalSingularUnit
options.roundingIncrement?	number
options.roundingMode?	TemporalRoundingMode

Returns

Instant

Defined in

types/IInstantFns.ts:74

---

equals

▸ equals(instant, other): boolean

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:82

---

isEqual

▸ isEqual(instant, other): boolean

alias for equals

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:86

---

isBefore

▸ isBefore(instant, other): boolean

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:87

---

isAfter

▸ isAfter(instant, other): boolean

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:88

---

isEqualOrBefore

▸ isEqualOrBefore(instant, other): boolean

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:89

---

isEqualOrAfter

▸ isEqualOrAfter(instant, other): boolean

Parameters

Name	Type
instant	Instant
other	Instant

Returns

boolean

Defined in

types/IInstantFns.ts:90

---

toZonedDateTime

▸ toZonedDateTime(instant, timeZone): ZonedDateTime

Parameters

Name	Type
instant	Instant
timeZone	string

Returns

ZonedDateTime

Defined in

types/IInstantFns.ts:91

---

formatISO9075

▸ formatISO9075(instant): string

Parameters

Name	Type
instant	Instant

Returns

string

Defined in

types/IInstantFns.ts:92

---

toJsDate

▸ toJsDate(instant): Date

Parameters

Name	Type
instant	Instant

Returns

Date

Defined in

types/IInstantFns.ts:93

---

fromEpochSeconds

▸ fromEpochSeconds(epochSeconds): Instant

Parameters

Name	Type
epochSeconds	number

Returns

Instant

Defined in

types/IInstantFns.ts:94

---

from

▸ from(item): Instant

Parameters

Name	Type
item	any

Returns

Instant

Defined in

types/IInstantFns.ts:95

---

compare

▸ compare(one, two): number

Parameters

Name	Type
one	Instant
two	Instant

Returns

number

Defined in

types/IInstantFns.ts:96

---

chain

▸ chain(instant): IInstantChain

Parameters

Name	Type
instant	Instant

Returns

IInstantChain

Defined in

types/IInstantFns.ts:97