Class IOracleIntervalYearToMonth

JavaScript API for Oracle type INTERVAL YEAR TO MONTH.

Hierarchy

IOracleIntervalYearToMonth

Index

Constructors

constructor

Methods

add compare divide fromNumberOfYears fromString getMonths getYears multiply subtract toString toStringWithPrecision

Constructors

constructor

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

Returns
new IOracleIntervalYearToMonth
Parameters
- yr: number
  
  year value
- mnth: number
  
  month value
Returns IOracleIntervalYearToMonth

Methods

add

add(other: IOracleIntervalYearToMonth): IOracleIntervalYearToMonth
Adds the interval to another interval and returns the resulting interval

Returns
the resulting interval as IOracleIntervalYearToMonth
Parameters
- other: IOracleIntervalYearToMonth
  
  the other interval
Returns IOracleIntervalYearToMonth

compare

compare(i1: IOracleIntervalYearToMonth, i2: IOracleIntervalYearToMonth): number
Compares two intervals

Returns
-1 if i1 < i2 0 if i1 = i2 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

divide

divide(dividend: number | OracleNumber): IOracleIntervalYearToMonth
Divides the interval by an OracleNumber or JavaScript number and returns the resulting interval

Returns
the resulting interval
Parameters
- dividend: number | OracleNumber
  
  the dividend used in the division
Returns IOracleIntervalYearToMonth

fromNumberOfYears

fromNumberOfYears(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.

Returns
new IOracleIntervalYearToMonth for the given number of years.
Parameters
- years: number | OracleNumber
Returns IOracleIntervalYearToMonth

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
Returns
new IOracleIntervalYearToMonth
Parameters
- interval: string
  
  string to parse
Returns IOracleIntervalYearToMonth

getMonths

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

Returns
the total number of months from the interval

Returns number

getYears

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

Returns
the number of years from the interval

Returns number

multiply

multiply(nfactor: number | OracleNumber): IOracleIntervalYearToMonth
Multiplies the interval with an OracleNumber or a JavaScript number and returns the resulting interval

Returns
the resulting interval
Parameters
- nfactor: number | OracleNumber
  
  the factor used in the multiplication
Returns IOracleIntervalYearToMonth

subtract

subtract(other: IOracleIntervalYearToMonth): IOracleIntervalYearToMonth
Subtracts another interval from the interval and returns the resulting interval

Returns
the resulting interval as IOracleIntervalYearToMonth
Parameters
- other: IOracleIntervalYearToMonth
  
  the other interval
Returns 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
a string representing the year-to-month interval

Returns string

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.

Returns
a string representing the interval
Parameters
- yearsPrecision: number
  
  The number of digits used to represent years in the interval string.
Returns string

Class IOracleIntervalYearToMonth

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns

Parameters

yr: number

mnth: number

Returns IOracleIntervalYearToMonth

Methods

add

Returns

Parameters

other: IOracleIntervalYearToMonth

Returns IOracleIntervalYearToMonth

compare

Returns

Parameters

i1: IOracleIntervalYearToMonth

i2: IOracleIntervalYearToMonth

Returns number

divide

Returns

Parameters

dividend: number | OracleNumber

Returns IOracleIntervalYearToMonth

fromNumberOfYears

Returns

Parameters

years: number | OracleNumber

Returns IOracleIntervalYearToMonth

fromString

Returns

Parameters

interval: string

Returns IOracleIntervalYearToMonth

getMonths

Returns

Returns number

getYears

Returns

Returns number

multiply

Returns

Parameters

nfactor: number | OracleNumber

Returns IOracleIntervalYearToMonth

subtract

Returns

Parameters

other: IOracleIntervalYearToMonth

Returns IOracleIntervalYearToMonth

toString

Returns

Returns string

toStringWithPrecision

Returns

Parameters

yearsPrecision: number

Returns string

Settings

Member Visibility

Theme