kotlin-js/js.temporal/Duration

Duration

open 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

blank

external val blank: Boolean

days

external val days: Int

hours

external val hours: Int

microseconds

external val microseconds: Int

milliseconds

external val milliseconds: Int

minutes

external val minutes: Int

months

external val months: Int

nanoseconds

external val nanoseconds: Int

seconds

external val seconds: Int

sign

external val sign: Int

weeks

external val weeks: Int

years

external val years: Int

Functions

abs

external fun abs(): Duration

add

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

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

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

negated

external fun negated(): Duration

round

external fun round(roundTo: JsAny): Duration

subtract

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

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

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

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

total

external fun total(totalOf: JsAny): Int

unaryMinus

operator external fun unaryMinus(): Duration

with

external fun with(durationLike: DurationLike): Duration