kotlin-js/js.temporal/PlainDate

PlainDate

external class PlainDate(isoYear: Int, isoMonth: Int, isoDay: Int, calendar: CalendarLike = definedExternally) : HasArithmeticOperations<PlainDate, PlainDateLike, DateUnit<*>> , Localizable<DateTimeFormatOptions> , CalendarLike(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: CalendarLike = definedExternally)

Types

Companion

object Companion : PlainCompanion<PlainDate, PlainDateLike>

Properties

calendarId

val calendarId: String

val day: Int

val dayOfWeek: Int

val dayOfYear: Int

val daysInMonth: Int

val daysInWeek: Int

val daysInYear: Int

val era: String?

val eraYear: Int?

val inLeapYear: Boolean

month

val month: Int

monthCode

val monthCode: String

monthsInYear

val monthsInYear: Int

weekOfYear

val weekOfYear: Int

year

val year: Int

yearOfWeek

val yearOfWeek: Int

Functions

add

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

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

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

getCalendar

fun getCalendar(): CalendarProtocol

getISOFields

fun getISOFields(): PlainDateISOFields

since

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

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

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

subtract

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

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

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

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.

toPlainDateTime

fun toPlainDateTime(temporalTime: PlainTime = definedExternally): PlainDateTime

toPlainMonthDay

fun toPlainMonthDay(): PlainMonthDay

toPlainYearMonth

fun toPlainYearMonth(): PlainYearMonth

toString

fun toString(options: ShowCalendarOption = definedExternally): String

toZonedDateTime

fun toZonedDateTime(timeZoneAndTime: Any): ZonedDateTime

until

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

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

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

with

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

withCalendar

fun withCalendar(calendar: CalendarLike): PlainDate