kotlin-js/js.temporal/Instant

Instant

external 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>

ToZonedDateTimeOptions

sealed interface ToZonedDateTimeOptions

Properties

epochMicroseconds

val epochMicroseconds: BigInt

epochMilliseconds

val epochMilliseconds: JsLong

epochNanoseconds

val epochNanoseconds: BigInt

epochSeconds

val epochSeconds: JsLong

Functions

add

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

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

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

round

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

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

since

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

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

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

subtract

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

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

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

toJSON

fun toJSON(): String

toLocaleString

open fun toLocaleString(): String

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

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

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

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

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

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

toString

fun toString(options: InstantToStringOptions = definedExternally): String

toZonedDateTime

fun toZonedDateTime(options: Instant.ToZonedDateTimeOptions): ZonedDateTime

toZonedDateTimeISO

fun toZonedDateTimeISO(tzLike: TimeZoneLike): ZonedDateTime

until

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

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

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