kotlin-js/js.temporal/Instant

Instant

open class Instant(val epochNanoseconds: BigInt) : HasArithmeticOperations<Instant, Nothing, TimeUnit<*>> , Roundable<Instant, TimeUnit<*>> , Localizable<DateTimeFormatOptions> (source)

A Temporal.Instant is an exact point in time, with a precision in nanoseconds. No time zone or calendar information is present. Therefore, Temporal.Instant has no concept of days, months, or even hours.

For convenience of interoperability, it internally uses nanoseconds since the {@link https://en.wikipedia.org/wiki/Unix_time|Unix epoch} (midnight UTC on January 1, 1970). However, a Temporal.Instant can be created from any of several expressions that refer to a single point in time, including an {@link https://en.wikipedia.org/wiki/ISO_8601|ISO 8601 string} with a time zone offset such as '2020-01-23T17:04:36.491865121-08:00'.

See https://tc39.es/proposal-temporal/docs/instant.html for more details.

Constructors

Instant

constructor(epochNanoseconds: BigInt)

Types

Companion

object Companion : Factory<Instant, Nothing, Nothing> , Comparator<Instant, Nothing>

Properties

epochMicroseconds

external val epochMicroseconds: BigInt

epochMilliseconds

external val epochMilliseconds: Int53

epochNanoseconds

external val epochNanoseconds: BigInt

epochSeconds

external val epochSeconds: Int53

Functions

add

open external fun add(duration: Duration, options: ArithmeticOptions = definedExternally): Instant

open external fun add(duration: DurationLike, options: ArithmeticOptions = definedExternally): Instant

open external fun add(duration: String, options: ArithmeticOptions = definedExternally): Instant

round

open external fun round(roundTo: RoundTo<TimeUnit<*>>): Instant

open external fun round(roundTo: SmallestUnit<TimeUnit<*>>): Instant

since

open external fun since(other: Nothing, options: DifferenceOptions<TimeUnit<*>>): Duration

open external fun since(other: Instant, options: DifferenceOptions<TimeUnit<*>>): Duration

open external fun since(other: String, options: DifferenceOptions<TimeUnit<*>>): Duration

subtract

open external fun subtract(duration: Duration, options: ArithmeticOptions = definedExternally): Instant

open external fun subtract(duration: DurationLike, options: ArithmeticOptions = definedExternally): Instant

open external fun subtract(duration: String, options: ArithmeticOptions = definedExternally): Instant

toJSON

external fun toJSON(): String

toLocaleString

open external fun toLocaleString(): String

Returns a value as a string value appropriate to the host environment's current locale.

open external fun toLocaleString(locales: UnicodeBCP47LocaleIdentifier, options: DateTimeFormatOptions = definedExternally): String

Converts a value to a string by using the current or specified locale.

open external fun toLocaleString(locales: ReadonlyArray<UnicodeBCP47LocaleIdentifier>, options: DateTimeFormatOptions = definedExternally): String

open external fun toLocaleString(locales: ReadonlyArray<Locale>, options: DateTimeFormatOptions = definedExternally): String

open external fun toLocaleString(locales: Locale, options: DateTimeFormatOptions = definedExternally): String

toString

external fun toString(options: InstantToStringOptions = definedExternally): String

toZonedDateTimeISO

external fun toZonedDateTimeISO(tzLike: TimeZone): ZonedDateTime

until

open external fun until(other: Nothing, options: DifferenceOptions<TimeUnit<*>>): Duration

open external fun until(other: Instant, options: DifferenceOptions<TimeUnit<*>>): Duration

open external fun until(other: String, options: DifferenceOptions<TimeUnit<*>>): Duration