Class IOracleIntervalYearToMonth

JavaScript API for Oracle type INTERVAL YEAR TO MONTH.

Index

Constructors

Methods

add divide getMonths getYears multiply subtract toString toStringWithPrecision compare fromNumber fromString

Constructors

constructor

new IOracleIntervalYearToMonth(
yr: number,
mnth: number,
): IOracleIntervalYearToMonth
Constructor for IOracleIntervalYearToMonth using year and month. All arguments must be integral numbers.
Parameters
- yr: number
  year value
- mnth: number
  month value
Returns IOracleIntervalYearToMonth
new IOracleIntervalYearToMonth

Methods

add

add(other: IOracleIntervalYearToMonth): IOracleIntervalYearToMonth
Adds the interval to another interval and returns the resulting interval
Parameters
- other: IOracleIntervalYearToMonth
  the other interval
Returns IOracleIntervalYearToMonth
the resulting interval as IOracleIntervalYearToMonth

divide

divide(dividend: number | OracleNumber): IOracleIntervalYearToMonth
Divides the interval by an OracleNumber or JavaScript number and returns the resulting interval
Parameters
- dividend: number | OracleNumber
  the dividend used in the division
Returns IOracleIntervalYearToMonth
the resulting interval

getMonths

getMonths(): number
Returns the total number of months from the interval

Returns number
the total number of months from the interval

getYears

getYears(): number
Returns the number of years from the interval

Returns number
the number of years from the interval

multiply

multiply(nfactor: number | OracleNumber): IOracleIntervalYearToMonth
Multiplies the interval with an OracleNumber or a JavaScript number and returns the resulting interval
Parameters
- nfactor: number | OracleNumber
  the factor used in the multiplication
Returns IOracleIntervalYearToMonth
the resulting interval

subtract

subtract(other: IOracleIntervalYearToMonth): IOracleIntervalYearToMonth
Subtracts another interval from the interval and returns the resulting interval
Parameters
- other: IOracleIntervalYearToMonth
  the other interval
Returns IOracleIntervalYearToMonth
the resulting interval as IOracleIntervalYearToMonth

toString

toString(): string
Given an interval, produces a string representing the interval. The string is formatted with at least 2 digits for the number of years.

Returns string
a string representing the year-to-month interval

toStringWithPrecision

toStringWithPrecision(yearsPrecision: number): string
Produces a string representing the interval. The string is formatted according to the specified precision for days and fractional seconds.
Parameters
- yearsPrecision: number
  The number of digits used to represent years in the interval string.
Returns string
a string representing the interval

`Static`compare

compare(i1: IOracleIntervalYearToMonth, i2: IOracleIntervalYearToMonth): number
Compares two intervals. Returns -1 if i1 < i2, 0 if they are equal, and 1 if i1 > i2.
Parameters
- i1: IOracleIntervalYearToMonth
  first interval to use for the comparison
- i2: IOracleIntervalYearToMonth
  second interval to use for the comparison
Returns number
the result of the comparison as a number between -1 and +1.

`Static`fromNumber

fromNumber(years: number | OracleNumber): IOracleIntervalYearToMonth
Returns an IOracleIntervalYearToMonth for the given number of years. If the number of years contains a fractional part, the number of months will be set accordingly.
Parameters
- years: number | OracleNumber
Returns IOracleIntervalYearToMonth
new IOracleIntervalYearToMonth for the given number of years.

`Static`fromString

fromString(interval: string): IOracleIntervalYearToMonth
Parse an interval string into IOracleIntervalYearToMonth. fromString accepts the same input formats as the Oracle SQL function TO_YMINTERVAL:
- SQL interval format compatible with the SQL standard (ISO/IEC 9075)
- ISO duration format compatible with the ISO 8601:2004 standard
Parameters
- interval: string
  string to parse
Returns IOracleIntervalYearToMonth
new IOracleIntervalYearToMonth