Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Node.js Driver. Switch to the latest stable version.
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 |
Number | The year or days since epoch. If days since epoch, month and day should not be provided. |
month |
Number | Between 1 and 12 inclusive. |
day |
Number | 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 :Number
If date cannot be represented yet given a valid days since epoch, track it internally.
Type:
- Number
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
Date object represent this date.
Type:
- Date
(readonly) day :Number
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.
Type:
- Number
(readonly) month :Number
A number between 1 and 12 inclusive representing the month. May return NaN if cannot be represented as a Date.
Type:
- Number
(readonly) value :Number
Always valid amount of days since epoch.
Type:
- Number
(readonly) year :Number
A number representing the year. May return NaN if cannot be represented as a Date.
Type:
- Number
Methods¶
compare(other) → {number}
Compares this LocalDate with the given one.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
LocalDate | 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.
- Type
- number
equals(other) → {Boolean}
Returns true if the value of the LocalDate instance and other are the same
Parameters:
| Name | Type | Description |
|---|---|---|
other |
LocalDate |
Returns:
- Type
- Boolean
toBuffer() → {Buffer}
Gets the bytes representation of the instance.
Returns:
- Type
- Buffer
toJSON() → {String}
Gets the string representation of the instance in the form: yyyy-mm-dd, valid for JSON.
Returns:
- Type
- String
toString() → {String}
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.
Returns:
- Type
- String
(static) fromBuffer(buffer)
Creates a new instance of LocalDate using the bytes representation.
Parameters:
| Name | Type | Description |
|---|---|---|
buffer |
Buffer |
(static) fromDate(date)
Creates a new instance of LocalDate using the year, month and day from the provided local date time.
Parameters:
| Name | Type | Description |
|---|---|---|
date |
Date |
(static) fromString(value)
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).
Parameters:
| Name | Type | Description |
|---|---|---|
value |
String |
(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.