Was this page helpful?
LocalDate¶
types~LocalDate(yearOrDaysSinceEpoch, month, day)
A date without a time-zone in the ISO-8601 calendar system, such as 2010-08-05.
LocalDate is an immutable object that represents a date, often viewed as year-month-day. For example, the value "1st October 2014" can be stored in a LocalDate.
This class does not store or represent a time or time-zone. Instead, it is a description of the date, as used for birthdays. It cannot represent an instant on the time-line without additional information such as an offset or time-zone.
Note that this type can represent dates in the range [-5877641-06-23; 5881580-07-17] while the ES5 date type can only represent values in the range of [-271821-04-20; 275760-09-13]. In the event that year, month, day parameters do not fall within the ES5 date range an Error will be thrown. If you wish to represent a date outside of this range, pass a single parameter indicating the days since epoch. For example, -1 represents 1969-12-31.
Constructor¶
new LocalDate(yearOrDaysSinceEpoch, month, day)
Creates a new instance of LocalDate.
Parameters:
| Name | Type | Description |
|---|---|---|
yearOrDaysSinceEpoch |
The year or days since epoch. If days since epoch, month and day should not be provided. |
|
month |
Between 1 and 12 inclusive. |
|
day |
Between 1 and the number of days in the given month of the given year. |
Properties:
| Name | Type | Description |
|---|---|---|
date |
Date | The date representation if falls within a range of an ES5 data type, otherwise an invalid date. |
Members¶
(readonly) _value
If date cannot be represented yet given a valid days since epoch, track it internally.
Deprecated
This member is in Datastax documentation, but it seems to not be exposed in the API. Additionally we added a new class member: `value` that always returns days since epoch regardless of the date.
(readonly) date
Date object represent this date.
(readonly) day
A number between 1 and the number of days in the given month of the given year (value up to 31). May return NaN if cannot be represented as a Date.
(readonly) month
A number between 1 and 12 inclusive representing the month. May return NaN if cannot be represented as a Date.
(readonly) value
Always valid amount of days since epoch.
(readonly) year
A number representing the year. May return NaN if cannot be represented as a Date.
Methods¶
compare(other)
Compares this LocalDate with the given one.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
date to compare against. |
Returns:
0 if they are the same, 1 if the this is greater, and -1 if the given one is greater.
equals()
Returns true if the value of the LocalDate instance and other are the same
toBuffer()
Gets the bytes representation of the instance.
toJSON()
Gets the string representation of the instance in the form: yyyy-mm-dd, valid for JSON.
toString()
Gets the string representation of the instance in the form: yyyy-mm-dd if the value can be parsed as a Date, otherwise days since epoch.
(static) fromBuffer()
Creates a new instance of LocalDate using the bytes representation.
(static) fromDate()
Creates a new instance of LocalDate using the year, month and day from the provided local date time.
(static) fromString()
Creates a new instance of LocalDate using the year, month and day provided in the form: yyyy-mm-dd or days since epoch (i.e. -1 for Dec 31, 1969).
(static) now()
Creates a new instance of LocalDate using the current year, month and day from the system clock in the default time-zone.
(static) utcNow()
Creates a new instance of LocalDate using the current date from the system clock at UTC.