kotlin-js/js.temporal/PlainYearMonth

PlainYearMonth

class PlainYearMonth(isoYear: Int, isoMonth: Int, calendar: Calendar = definedExternally, referenceISODay: Int = definedExternally) : HasArithmeticOperations<PlainYearMonth, PlainYearMonthLike, DateUnit<*>> , Localizable<DateTimeFormatOptions> (source)

A Temporal.PlainYearMonth represents a particular month on the calendar. For example, it could be used to represent a particular instance of a monthly recurring event, like "the June 2019 meeting".

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

Constructors

PlainYearMonth

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

Types

Companion

object Companion : PlainCompanion<PlainYearMonth, PlainYearMonthLike>

ToPlainDateOptions

interface ToPlainDateOptions

Properties

calendarId

var calendarId: String

var daysInMonth: Int

var daysInYear: Int

var era: String?

var eraYear: Int?

var inLeapYear: Boolean

month

var month: Int

monthCode

var monthCode: String

monthsInYear

var monthsInYear: Int

year

var year: Int

Functions

add

open fun add(duration: Duration, options: ArithmeticOptions): PlainYearMonth

open fun add(duration: DurationLike, options: ArithmeticOptions): PlainYearMonth

open fun add(duration: String, options: ArithmeticOptions): PlainYearMonth

getISOFields

fun getISOFields(): PlainDateISOFields

since

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

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

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

subtract

open fun subtract(duration: Duration, options: ArithmeticOptions): PlainYearMonth

open fun subtract(duration: DurationLike, options: ArithmeticOptions): PlainYearMonth

open fun subtract(duration: String, options: ArithmeticOptions): PlainYearMonth

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: ReadonlyArray<UnicodeBCP47LocaleIdentifier>, options: DateTimeFormatOptions): String

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

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

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

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

toPlainDate

fun toPlainDate(options: PlainYearMonth.ToPlainDateOptions): PlainDate

toString

fun toString(options: ShowCalendarOption = definedExternally): String

until

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

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

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

with

fun with(yearMonthLike: PlainYearMonthLike, options: AssignmentOptions = definedExternally): PlainYearMonth