# DateTimeHelper Class
# Constructors
# constructor
+ new DateTimeHelper(config: Config): DateTimeHelper
Defined in src/DateTimeHelper.ts:58 (opens new window)
Parameters:
| Name | Type |
|---|---|
config | Config |
Returns: DateTimeHelper
# Methods
# dateStringToDateNumber
▸ dateStringToDateNumber(dateTimeString: string): Maybe‹ExtendedNumber›
Defined in src/DateTimeHelper.ts:81 (opens new window)
Parameters:
| Name | Type |
|---|---|
dateTimeString | string |
Returns: Maybe‹ExtendedNumber›
# dateToNumber
▸ dateToNumber(date: SimpleDate): number
Defined in src/DateTimeHelper.ts:131 (opens new window)
Parameters:
| Name | Type |
|---|---|
date | SimpleDate |
Returns: number
# dayCountByBasis
▸ dayCountByBasis(startDate: number, endDate: number, basis: number): object
Defined in src/DateTimeHelper.ts:231 (opens new window)
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
▸ daysInMonth(year: number, month: number): number
Defined in src/DateTimeHelper.ts:167 (opens new window)
Parameters:
| Name | Type |
|---|---|
year | number |
month | number |
Returns: number
# endOfMonth
▸ endOfMonth(date: SimpleDate): SimpleDate
Defined in src/DateTimeHelper.ts:175 (opens new window)
Parameters:
| Name | Type |
|---|---|
date | SimpleDate |
Returns: SimpleDate
# getEpochYearZero
▸ getEpochYearZero(): number
Defined in src/DateTimeHelper.ts:109 (opens new window)
Returns: number
# getNullYear
▸ getNullYear(): number
Defined in src/DateTimeHelper.ts:105 (opens new window)
Returns: number
# getWithinBounds
▸ getWithinBounds(dayNumber: number): Maybe‹number›
Defined in src/DateTimeHelper.ts:77 (opens new window)
Parameters:
| Name | Type |
|---|---|
dayNumber | number |
Returns: Maybe‹number›
# isValidDate
▸ isValidDate(date: SimpleDate): boolean
Defined in src/DateTimeHelper.ts:113 (opens new window)
Parameters:
| Name | Type |
|---|---|
date | SimpleDate |
Returns: boolean
# leapYearsCount
▸ leapYearsCount(year: number): number
Defined in src/DateTimeHelper.ts:163 (opens new window)
Parameters:
| Name | Type |
|---|---|
year | number |
Returns: number
# numberToSimpleDate
▸ numberToSimpleDate(arg: number): SimpleDate
Defined in src/DateTimeHelper.ts:139 (opens new window)
Parameters:
| Name | Type |
|---|---|
arg | number |
Returns: SimpleDate
# numberToSimpleDateTime
▸ numberToSimpleDateTime(arg: number): SimpleDateTime
Defined in src/DateTimeHelper.ts:154 (opens new window)
Parameters:
| Name | Type |
|---|---|
arg | number |
Returns: SimpleDateTime
# parseDateTimeFromConfigFormats
▸ parseDateTimeFromConfigFormats(dateTimeString: string): Partial‹object›
Defined in src/DateTimeHelper.ts:101 (opens new window)
Parameters:
| Name | Type |
|---|---|
dateTimeString | string |
Returns: Partial‹object›
# relativeNumberToAbsoluteNumber
▸ relativeNumberToAbsoluteNumber(arg: number): number
Defined in src/DateTimeHelper.ts:135 (opens new window)
Parameters:
| Name | Type |
|---|---|
arg | number |
Returns: number
# toBasisUS
▸ toBasisUS(start: SimpleDate, end: SimpleDate): [SimpleDate, SimpleDate]
Defined in src/DateTimeHelper.ts:179 (opens new window)
Parameters:
| Name | Type |
|---|---|
start | SimpleDate |
end | SimpleDate |
Returns: [SimpleDate, SimpleDate]
# yearLengthForBasis
▸ yearLengthForBasis(start: SimpleDate, end: SimpleDate): number
Defined in src/DateTimeHelper.ts:195 (opens new window)
Parameters:
| Name | Type |
|---|---|
start | SimpleDate |
end | SimpleDate |
Returns: number