DateTimeHelper
Class
Constructors
Section titled “Constructors”constructor
Section titled “constructor”+ new DateTimeHelper(config: Config): DateTimeHelper
Defined in hyperformula/src/DateTimeHelper.ts:58
Parameters:
| Name | Type |
|---|---|
config |
Config |
Returns: DateTimeHelper
Methods
Section titled “Methods”dateStringToDateNumber
Section titled “dateStringToDateNumber”▸ dateStringToDateNumber(dateTimeString: string): Maybe‹ExtendedNumber›
Defined in hyperformula/src/DateTimeHelper.ts:81
Parameters:
| Name | Type |
|---|---|
dateTimeString |
string |
Returns: Maybe‹ExtendedNumber›
dateToNumber
Section titled “dateToNumber”▸ dateToNumber(date: SimpleDate): number
Defined in hyperformula/src/DateTimeHelper.ts:131
Parameters:
| Name | Type |
|---|---|
date |
SimpleDate |
Returns: number
dayCountByBasis
Section titled “dayCountByBasis”▸ dayCountByBasis(startDate: number, endDate: number, basis: number): object
Defined in hyperformula/src/DateTimeHelper.ts:239
Counts the days between two dates under a day-count basis, and returns the number of days in a year under the
same basis. YEARFRAC and the securities functions (DISC, INTRATE, PRICEDISC, RECEIVED, YIELDDISC, ACCRINTM)
compute their year fraction as dayCount / yearDays.
basis |
dayCount |
yearDays |
|---|---|---|
| 0 | US (NASD) 30/360, as adjusted by toBasisUS |
360 |
| 1 | actual days | yearLengthForBasis |
| 2 | actual days | 360 |
| 3 | actual days | 365 |
| 4 | European 30/360, as adjusted by toBasisEU |
360 |
Parameters:
| Name | Type | Description |
|---|---|---|
startDate |
number | date serial number, an integer not greater than endDate |
endDate |
number | date serial number, an integer |
basis |
number | day-count basis, an integer from 0 to 4 |
Returns: object
-
dayCount: number
-
yearDays: number
daysInMonth
Section titled “daysInMonth”▸ daysInMonth(year: number, month: number): number
Defined in hyperformula/src/DateTimeHelper.ts:167
Parameters:
| Name | Type |
|---|---|
year |
number |
month |
number |
Returns: number
endOfMonth
Section titled “endOfMonth”▸ endOfMonth(date: SimpleDate): SimpleDate
Defined in hyperformula/src/DateTimeHelper.ts:175
Parameters:
| Name | Type |
|---|---|
date |
SimpleDate |
Returns: SimpleDate
getEpochYearZero
Section titled “getEpochYearZero”▸ getEpochYearZero(): number
Defined in hyperformula/src/DateTimeHelper.ts:109
Returns: number
getNullYear
Section titled “getNullYear”▸ getNullYear(): number
Defined in hyperformula/src/DateTimeHelper.ts:105
Returns: number
getWithinBounds
Section titled “getWithinBounds”▸ getWithinBounds(dayNumber: number): Maybe‹number›
Defined in hyperformula/src/DateTimeHelper.ts:77
Parameters:
| Name | Type |
|---|---|
dayNumber |
number |
Returns: Maybe‹number›
isValidDate
Section titled “isValidDate”▸ isValidDate(date: SimpleDate): boolean
Defined in hyperformula/src/DateTimeHelper.ts:113
Parameters:
| Name | Type |
|---|---|
date |
SimpleDate |
Returns: boolean
leapYearsCount
Section titled “leapYearsCount”▸ leapYearsCount(year: number): number
Defined in hyperformula/src/DateTimeHelper.ts:163
Parameters:
| Name | Type |
|---|---|
year |
number |
Returns: number
numberToSimpleDate
Section titled “numberToSimpleDate”▸ numberToSimpleDate(arg: number): SimpleDate
Defined in hyperformula/src/DateTimeHelper.ts:139
Parameters:
| Name | Type |
|---|---|
arg |
number |
Returns: SimpleDate
numberToSimpleDateTime
Section titled “numberToSimpleDateTime”▸ numberToSimpleDateTime(arg: number): SimpleDateTime
Defined in hyperformula/src/DateTimeHelper.ts:154
Parameters:
| Name | Type |
|---|---|
arg |
number |
Returns: SimpleDateTime
parseDateTimeFromConfigFormats
Section titled “parseDateTimeFromConfigFormats”▸ parseDateTimeFromConfigFormats(dateTimeString: string): Partial‹object›
Defined in hyperformula/src/DateTimeHelper.ts:101
Parameters:
| Name | Type |
|---|---|
dateTimeString |
string |
Returns: Partial‹object›
relativeNumberToAbsoluteNumber
Section titled “relativeNumberToAbsoluteNumber”▸ relativeNumberToAbsoluteNumber(arg: number): number
Defined in hyperformula/src/DateTimeHelper.ts:135
Parameters:
| Name | Type |
|---|---|
arg |
number |
Returns: number
toBasisUS
Section titled “toBasisUS”▸ toBasisUS(start: SimpleDate, end: SimpleDate): [SimpleDate, SimpleDate]
Defined in hyperformula/src/DateTimeHelper.ts:187
Parameters:
| Name | Type |
|---|---|
start |
SimpleDate |
end |
SimpleDate |
Returns: [SimpleDate, SimpleDate]
truncateDayInMonth
Section titled “truncateDayInMonth”▸ truncateDayInMonth(date: SimpleDate): SimpleDate
Defined in hyperformula/src/DateTimeHelper.ts:183
Clamps the day of the month so that it does not exceed the number of days in that month. Leap years, including the configurable 1900 leap year, are taken into account.
Parameters:
| Name | Type |
|---|---|
date |
SimpleDate |
Returns: SimpleDate
yearLengthForBasis
Section titled “yearLengthForBasis”▸ yearLengthForBasis(start: SimpleDate, end: SimpleDate): number
Defined in hyperformula/src/DateTimeHelper.ts:203
Parameters:
| Name | Type |
|---|---|
start |
SimpleDate |
end |
SimpleDate |
Returns: number