Class LocalDate

A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.

See java.time.LocalDate for full documentation

Hierarchy

  • LocalDate

Constructors

constructor

Methods

adjustInto atStartOfDay atTime compareTo datesUntil format get getDayOfMonth getDayOfWeek getDayOfYear getLong getMonth getMonthValue getYear isAfter isBefore isEqual isLeapYear isSupported lengthOfMonth lengthOfYear minus minusDays minusMonths minusWeeks minusYears plus plusDays plusMonths plusWeeks plusYears query range toEpochDay until with withDayOfMonth withDayOfYear withMonth withYear from now of ofEpochDay ofInstant ofYearDay parse

Constructors

constructor

Methods

adjustInto

  • Adjusts the specified temporal object to have the same date as this object.

    Parameters

    Returns Temporal

atStartOfDay

  • Combines this date with the time of midnight to create a ZonedDateTime at the start of this date.

    Parameters

    • zone: ZoneId

      Returns a zoned date-time from this date at the earliest valid time according to the rules in the time-zone.

    Returns ZonedDateTime

  • Combines this date with the time of midnight to create a LocalDateTime at the start of this date.

    Returns LocalDateTime

atTime

  • Combines this date with a time to create a LocalDateTime.

    Parameters

    • Optional hour: number
    • Optional minute: number

    Returns LocalDateTime

  • Combines this date with a time to create a LocalDateTime.

    Parameters

    • Optional hour: number
    • Optional minute: number
    • Optional second: number

    Returns LocalDateTime

  • Combines this date with a time to create a LocalDateTime.

    Parameters

    • Optional hour: number
    • Optional minute: number
    • Optional second: number
    • Optional nanoOfSecond: number

    Returns LocalDateTime

  • Combines this date with a time to create a LocalDateTime.

    Parameters

    Returns LocalDateTime

  • Combines this date with an offset time to create an OffsetDateTime.

    Parameters

    Returns OffsetDateTime

compareTo

  • Compares this date to another date.

    Parameters

    Returns number

datesUntil

format

  • Formats this date using the specified formatter.

    Parameters

    Returns string

get

  • Gets the value of the specified field from this date as an int.

    Parameters

    Returns number

getDayOfMonth

  • Gets the day-of-month field. The first day of the month is 1.

    Returns number

getDayOfWeek

  • Gets the day-of-week field, which is an enum DayOfWeek. Use the method getValue() to extract the numeric value of the day Remember that "Monday" has a getValue of 1, and "Sunday" a getValue of 7

    Returns DayOfWeek

getDayOfYear

  • Gets the day-of-year field. The minimum value of this is 1, and the max is 365 or 366 depending on if it is a leapyear

    Returns number

getLong

  • Gets the value of the specified field from this date as a long.

    Parameters

    Returns number

getMonth

  • Gets the month-of-year field using the Month enum.

    Returns Month

getMonthValue

  • Gets the month-of-year field from 1 to 12.

    Returns number

getYear

  • Gets the year field.

    Returns number

isAfter

  • Checks if this date is after the specified date.

    Parameters

    Returns boolean

isBefore

  • Checks if this date is before the specified date.

    Parameters

    Returns boolean

isEqual

  • Checks if this date is equal to the specified date.

    Parameters

    Returns boolean

isLeapYear

  • Checks if the year is a leap year, according to the ISO proleptic calendar system rules.

    Returns boolean

isSupported

  • Checks if the specified field is supported.

    Parameters

    Returns boolean

  • Checks if the specified unit is supported.

    Parameters

    Returns boolean

lengthOfMonth

  • Returns the length of the month represented by this date.

    Returns number

lengthOfYear

  • Returns the length of the year represented by this date.

    Returns number

minus

  • Returns a copy of this date with the specified amount subtracted.

    Parameters

    Returns LocalDate

  • Returns a copy of this date with the specified amount subtracted.

    Parameters

    Returns LocalDate

minusDays

  • Returns a copy of this LocalDate with the specified number of days subtracted.

    Parameters

    • daysToSubtract: number

    Returns LocalDate

minusMonths

  • Returns a copy of this LocalDate with the specified number of months subtracted.

    Parameters

    • monthsToSubtract: number

    Returns LocalDate

minusWeeks

  • Returns a copy of this LocalDate with the specified number of weeks subtracted.

    Parameters

    • weeksToSubtract: number

    Returns LocalDate

minusYears

  • Returns a copy of this LocalDate with the specified number of years subtracted.

    Parameters

    • yearsToSubtract: number

    Returns LocalDate

plus

  • Returns a copy of this date with the specified amount added.

    Parameters

    Returns LocalDate

  • Returns a copy of this date with the specified amount added.

    Parameters

    Returns LocalDate

plusDays

  • Returns a copy of this LocalDate with the specified number of days added.

    Parameters

    • daysToAdd: number

    Returns LocalDate

plusMonths

  • Returns a copy of this LocalDate with the specified number of months added.

    Parameters

    • monthsToAdd: number

    Returns LocalDate

plusWeeks

  • Returns a copy of this LocalDate with the specified number of weeks added.

    Parameters

    • weeksToAdd: number

    Returns LocalDate

plusYears

  • Returns a copy of this LocalDate with the specified number of years added.

    Parameters

    • yearsToAdd: number

    Returns LocalDate

query

  • Queries this date using the specified query.

    Type Parameters

    • R

    Parameters

    Returns R

range

toEpochDay

  • Converts this LocalDate to the number of days since the epoch of 1970-01-01.

    Returns number

until

  • Calculates the period between this date and another date as a Period.

    Parameters

    Returns Period

  • Calculates the amount of time until another date in terms of the specified unit.

    Parameters

    Returns number

with

  • Returns an adjusted copy of this date.

    Parameters

    Returns LocalDate

  • Returns a copy of this date with the specified field set to a new value.

    Parameters

    Returns LocalDate

withDayOfMonth

  • Returns a copy of this LocalDate with the day-of-month altered.

    NOTE: this method does not accept negative numbers and will throw an exception if the day of month is invalid for the relevant month

    Parameters

    • dayOfMonth: number

      the day-of-month to set in the result, from 1 to 28-31

    Returns LocalDate

    Example

    If you want the last day of the month

    B.time.LocalDate.now().withDayOfMonth(1).plusMonths(1).minusDays(1)

withDayOfYear

  • Returns a copy of this LocalDate with the day-of-year altered.

    Parameters

    • dayOfYear: number

      the day-of-year to set in the result, from 1 to 365-366

    Returns LocalDate

withMonth

  • Returns a copy of this LocalDate with the month-of-year altered.

    Parameters

    • month: number

      the month-of-year to set in the result, from 1 (January) to 12 (December)

    Returns LocalDate

withYear

  • Returns a copy of this LocalDate with the year altered.

    Parameters

    • year: number

      the year to set in the result, from MIN_YEAR to MAX_YEAR

    Returns LocalDate

Static from

Static now

  • Obtains the current date from the system clock in the default time-zone.

    Returns LocalDate

  • Obtains the current date from the specified clock.

    Parameters

    Returns LocalDate

  • Obtains the current date from the system clock in the specified time-zone.

    Parameters

    Returns LocalDate

Static of

  • Obtains an instance of LocalDate from a year, month and day.

    Parameters

    • year: number
    • month: number
    • dayOfMonth: number

    Returns LocalDate

  • Obtains an instance of LocalDate from a year, month and day.

    Parameters

    • year: number
    • month: Month
    • dayOfMonth: number

    Returns LocalDate

Static ofEpochDay

  • Obtains an instance of LocalDate from the epoch day count.

    Parameters

    • epochDay: number

    Returns LocalDate

Static ofInstant

  • Obtains an instance of LocalDate from an Instant and zone ID.

    Parameters

    Returns LocalDate

Static ofYearDay

  • Obtains an instance of LocalDate from a year and day-of-year.

    Parameters

    • year: number
    • dayOfYear: number

    Returns LocalDate

Static parse

  • Obtains an instance of LocalDate from a text string such as 2007-12-03.

    Parameters

    Returns LocalDate

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc