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