kotlin-js/js.temporal/PlainDate

PlainDate

open class PlainDate(isoYear: Int, isoMonth: Int, isoDay: Int, calendar: Calendar = definedExternally) : HasArithmeticOperations<PlainDate, PlainDateLike, DateUnit<*>> , Localizable<DateTimeFormatOptions> (source)

A Temporal.PlainDate represents a calendar date. "Calendar date" refers to the concept of a date as expressed in everyday usage, independent of any time zone. For example, it could be used to represent an event on a calendar which happens during the whole day no matter which time zone it's happening in.

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

Constructors

PlainDate

constructor(isoYear: Int, isoMonth: Int, isoDay: Int, calendar: Calendar = definedExternally)

Types

Companion

object Companion : PlainCompanion<PlainDate, PlainDateLike>

Properties

calendarId

external val calendarId: Calendar

day

external val day: Int

dayOfWeek

external val dayOfWeek: Int

dayOfYear

external val dayOfYear: Int

daysInMonth

external val daysInMonth: Int

daysInWeek

external val daysInWeek: Int

daysInYear

external val daysInYear: Int

era

external val era: String?

eraYear

external val eraYear: Int?

inLeapYear

external val inLeapYear: Boolean

month

external val month: Int

monthCode

external val monthCode: String

monthsInYear

external val monthsInYear: Int

weekOfYear

external val weekOfYear: Int

year

external val year: Int

yearOfWeek

external val yearOfWeek: Int

Functions

add

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

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

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

getISOFields

external fun getISOFields(): PlainDateISOFields

since

open external fun since(other: PlainDateLike, options: DifferenceOptions<DateUnit<*>>): Duration

open external fun since(other: PlainDate, options: DifferenceOptions<DateUnit<*>>): Duration

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

subtract

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

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

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

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

toPlainDateTime

external fun toPlainDateTime(temporalTime: PlainTime = definedExternally): PlainDateTime

toPlainMonthDay

external fun toPlainMonthDay(): PlainMonthDay

toPlainYearMonth

external fun toPlainYearMonth(): PlainYearMonth

toString

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

toZonedDateTime

external fun toZonedDateTime(timeZoneAndTime: JsAny): ZonedDateTime

until

open external fun until(other: PlainDateLike, options: DifferenceOptions<DateUnit<*>>): Duration

open external fun until(other: PlainDate, options: DifferenceOptions<DateUnit<*>>): Duration

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

with

external fun with(dateLike: PlainDateLike, options: AssignmentOptions = definedExternally): PlainDate

withCalendar

external fun withCalendar(calendar: Calendar): PlainDate