kotlin-js/js.temporal/Duration

Duration

external class Duration(val years: Int = definedExternally, val months: Int = definedExternally, val weeks: Int = definedExternally, val days: Int = definedExternally, val hours: Int = definedExternally, val minutes: Int = definedExternally, val seconds: Int = definedExternally, val milliseconds: Int = definedExternally, val microseconds: Int = definedExternally, val nanoseconds: Int = definedExternally) : HasDurationOperations<Duration, DurationArithmeticOptions> , Localizable<DateTimeFormatOptions> (source)

A Temporal.Duration represents an immutable duration of time which can be used in date/time arithmetic.

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

Constructors

Duration

constructor(years: Int = definedExternally, months: Int = definedExternally, weeks: Int = definedExternally, days: Int = definedExternally, hours: Int = definedExternally, minutes: Int = definedExternally, seconds: Int = definedExternally, milliseconds: Int = definedExternally, microseconds: Int = definedExternally, nanoseconds: Int = definedExternally)

Types

Companion

object Companion : Factory<Duration, DurationLike, Nothing>

Properties

val blank: Boolean

val days: Int

val hours: Int

val microseconds: Int

milliseconds

val milliseconds: Int

val minutes: Int

val months: Int

val nanoseconds: Int

val seconds: Int

val sign: Int

val weeks: Int

val years: Int

Functions

abs

fun abs(): Duration

add

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

open fun add(duration: DurationLike, options: DurationArithmeticOptions = definedExternally): Duration

open fun add(duration: String, options: DurationArithmeticOptions = definedExternally): Duration

negated

fun negated(): Duration

round

fun round(roundTo: Any): Duration

subtract

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

open fun subtract(duration: DurationLike, options: DurationArithmeticOptions = definedExternally): Duration

open fun subtract(duration: String, options: DurationArithmeticOptions = definedExternally): Duration

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: ToStringPrecisionOptions = definedExternally): String

total

fun total(totalOf: Any): Int

unaryMinus

operator fun unaryMinus(): Duration

with

fun with(durationLike: DurationLike): Duration