API Reference Overview

Detects Excel LCID-tagged currency tags ([$SYMBOL-LCID] with a non-empty SYMBOL portion). Shared by defaultStringifyDateTime and defaultStringifyDuration so a format string carrying such a tag short- circuits both date and duration dispatch and falls through to the number formatter (or the user-supplied stringifyCurrency callback).

The pattern is intentionally unanchored: any occurrence of [$SYMBOL- in the format string triggers the guard. Excel does not mix date/time tokens with a currency tag in the same format string, so a mid-string match cannot misclassify a legitimate composite — every observed format string with a currency tag is currency-only.

MINUTES_PER_HOUR

• MINUTES_PER_HOUR: 60 = 60

Defined in src/DateTimeHelper.ts:14

NOT_FOUND

• NOT_FOUND: -1 = -1

Defined in src/Lookup/AdvancedFind.ts:19

QUICK_CHECK_REGEXP

• QUICK_CHECK_REGEXP: RegExp‹› = new RegExp(’^[0-9/.\-: ]+[ap]?m?$’)

Defined in src/DateTimeDefault.ts:11

SECONDS_PER_MINUTE

• SECONDS_PER_MINUTE: 60 = 60

Defined in src/DateTimeHelper.ts:13

SECONDS_PRECISION

• SECONDS_PRECISION: 1000 = 1000

Defined in src/DateTimeDefault.ts:15

TIME_FORMAT_SECONDS_ITEM_REGEXP

• TIME_FORMAT_SECONDS_ITEM_REGEXP: RegExp‹› = new RegExp(‘^ss(\.(s+|0+))?$’)

Defined in src/DateTimeDefault.ts:9

TIME_SEPARATOR

• TIME_SEPARATOR: ”:” = ”:”

Defined in src/DateTimeDefault.ts:14

WHITESPACE_REGEXP

• WHITESPACE_REGEXP: RegExp‹› = new RegExp(‘\s+’)

Defined in src/DateTimeDefault.ts:12

WRONG_RANGE_SIZE

• WRONG_RANGE_SIZE: “AbsoluteCellRange: Wrong range size” = “AbsoluteCellRange: Wrong range size”

Defined in src/AbsoluteCellRange.ts:22

_notified

• _notified: boolean = false

Defined in src/helpers/licenseKeyValidator.ts:43

_rl

• _rl: “length” = “length”

Defined in src/helpers/licenseKeyHelper.ts:9

dateFormatRegex

• dateFormatRegex: RegExp‹› = /(\.|dd|DD|d|D|mm|MM|m|M|YYYY|YY|yyyy|yy|HH|hh|H|h|ss(.(0+|s+))?|s|AM/PM|am/pm|A/P|a/p|[mm]|[MM]|[hh]|[HH])/g

Defined in src/format/parser.ts:8

defaultLanguage

• defaultLanguage: string = Config.defaultConfig.language

Defined in src/index.ts:108

memoizedParseDateFormat

• memoizedParseDateFormat: (Anonymous function) = memoize(parseDateFormat)

Defined in src/DateTimeDefault.ts:17

memoizedParseTimeFormat

• memoizedParseTimeFormat: (Anonymous function) = memoize(parseTimeFormat)

Defined in src/DateTimeDefault.ts:16

numDays

• numDays: number[] = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]

Defined in src/DateTimeHelper.ts:10

numberFormatRegex

• numberFormatRegex: RegExp‹› = /(\.|[#0]+(.[#0]*)?)/g

Defined in src/format/parser.ts:9

prefSumDays

• prefSumDays: number[] = [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334]

Defined in src/DateTimeHelper.ts:11

privatePool

• privatePool: WeakMap‹Config, object› = new WeakMap()

Defined in src/Config.ts:27

Functions

CellValueTypeOrd

▸ CellValueTypeOrd(arg: CellValueType): number

Defined in src/Cell.ts:97

Parameters:

Name	Type
`arg`	CellValueType

Returns: number

_cp

▸ _cp(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:14

Parameters:

Name	Type
`v`	any

Returns: number

_hd

▸ _hd(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:10

Parameters:

Name	Type
`v`	any

Returns: number

_nm

▸ _nm(v: any): string

Defined in src/helpers/licenseKeyHelper.ts:12

Parameters:

Name	Type
`v`	any

Returns: string

_pi

▸ _pi(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:11

Parameters:

Name	Type
`v`	any

Returns: number

_ss

▸ _ss(v: any, s: any, l: any): any

Defined in src/helpers/licenseKeyHelper.ts:13

Parameters:

Name	Type
`v`	any
`s`	any
`l`	any

Returns: any

absoluteSheetReference

▸ absoluteSheetReference(address: AddressWithSheet, baseAddress: SimpleCellAddress): number

Defined in src/Cell.ts:222

Parameters:

Name	Type
`address`	AddressWithSheet
`baseAddress`	SimpleCellAddress

Returns: number

absolutizeDependencies

▸ absolutizeDependencies(deps: RelativeDependency[], baseAddress: SimpleCellAddress): CellDependency[]

Defined in src/absolutizeDependencies.ts:17

Converts dependencies from maybe relative addressing to absolute addressing.

Parameters:

Name	Type	Description
`deps`	RelativeDependency[]	list of addresses in R0C0 format
`baseAddress`	SimpleCellAddress	base address with regard to which make a convertion

Returns: CellDependency[]

addressKey

▸ addressKey(address: SimpleCellAddress): string

Defined in src/Cell.ts:209

Parameters:

Name	Type
`address`	SimpleCellAddress

Returns: string

arraySizeForBinaryOp

▸ arraySizeForBinaryOp(leftArraySize: ArraySize, rightArraySize: ArraySize): ArraySize

Defined in src/ArraySize.ts:34

Parameters:

Name	Type
`leftArraySize`	ArraySize
`rightArraySize`	ArraySize

Returns: ArraySize

arraySizeForUnaryOp

▸ arraySizeForUnaryOp(arraySize: ArraySize): ArraySize

Defined in src/ArraySize.ts:38

Parameters:

Name	Type
`arraySize`	ArraySize

Returns: ArraySize

buildColumnSearchStrategy

▸ buildColumnSearchStrategy(dependencyGraph: DependencyGraph, config: Config, statistics: Statistics): ColumnSearchStrategy

Defined in src/Lookup/SearchStrategy.ts:63

Parameters:

Name	Type
`dependencyGraph`	DependencyGraph
`config`	Config
`statistics`	Statistics

Returns: ColumnSearchStrategy

checkKeySchema

▸ checkKeySchema(v: any): boolean

Defined in src/helpers/licenseKeyHelper.ts:20

Parameters:

Name	Type
`v`	any

Returns: boolean

checkLicenseKeyValidity

▸ checkLicenseKeyValidity(licenseKey: string): LicenseKeyValidityState

Defined in src/helpers/licenseKeyValidator.ts:51

Checks if the provided license key is grammatically valid or not expired.

Parameters:

Name	Type	Description
`licenseKey`	string	The license key to check.

Returns: LicenseKeyValidityState

Returns the checking state.

collatorFromConfig

▸ collatorFromConfig(config: Config): Collator

Defined in src/StringHelper.ts:8

Parameters:

Name	Type
`config`	Config

Returns: Collator

configCheckIfParametersNotInConflict

▸ configCheckIfParametersNotInConflict(…params: object[]): void

Defined in src/ArgumentSanitization.ts:57

Parameters:

Name	Type
`...params`	object[]

Returns: void

configValueFromParam

▸ configValueFromParam(inputValue: any, expectedType: string | string[], paramName: ConfigParamsList): any

Defined in src/ArgumentSanitization.ts:16

Parameters:

Name	Type
`inputValue`	any
`expectedType`	string \| string[]
`paramName`	ConfigParamsList

Returns: any

configValueFromParamCheck

▸ configValueFromParamCheck(inputValue: any, typeCheck: function, expectedType: string, paramName: ConfigParamsList): any

Defined in src/ArgumentSanitization.ts:47

Parameters:

▪ inputValue: any

▪ typeCheck: function

▸ (object: any): boolean

Parameters:

Name	Type
`object`	any

▪ expectedType: string

▪ paramName: ConfigParamsList

Returns: any

countChars

▸ countChars(text: string, char: string): number

Defined in src/format/format.ts:74

Parameters:

Name	Type
`text`	string
`char`	string

Returns: number

createTokens

▸ createTokens(regexTokens: RegExpExecArray[], str: string): FormatToken[]

Defined in src/format/parser.ts:66

Parameters:

Name	Type
`regexTokens`	RegExpExecArray[]
`str`	string

Returns: FormatToken[]

dayToMonth

▸ dayToMonth(dayOfYear: number): number

Defined in src/DateTimeHelper.ts:270

Parameters:

Name	Type
`dayOfYear`	number

Returns: number

defaultParseToDate

▸ defaultParseToDate(dateItems: string[], dateFormat: Maybe‹string›): Maybe‹SimpleDate›

Defined in src/DateTimeDefault.ts:137

Parses a date value from a string if the string matches the given date format.

Parameters:

Name	Type
`dateItems`	string[]
`dateFormat`	Maybe‹string›

Returns: Maybe‹SimpleDate›

defaultParseToDateTime

▸ defaultParseToDateTime(text: string, dateFormat: Maybe‹string›, timeFormat: Maybe‹string›): Maybe‹DateTime›

Defined in src/DateTimeDefault.ts:30

Parses a DateTime value from a string if the string matches the given date format and time format.

Idea for more readable implementation:

divide string into parts by a regexp [date_regexp]? [time_regexp]? [ampm_regexp]?
start by finding the time part, because it is unambiguous ’([0-9]+:[0-9:.]+ ?[ap]?m?)$’, before it is the date part
OR split by spaces - last segment is ampm token, second to last is time (with or without ampm), rest is date If applied:
date parsing might work differently after these changes but still according to the docs
make sure to test edge cases like timeFormats: [‘hh’, ‘ss.ss’] etc, string: ‘01-01-2019 AM’, ‘PM’

Parameters:

Name	Type
`text`	string
`dateFormat`	Maybe‹string›
`timeFormat`	Maybe‹string›

Returns: Maybe‹DateTime›

defaultParseToTime

▸ defaultParseToTime(timeItems: string[], timeFormat: Maybe‹string›): Maybe‹SimpleTime›

Defined in src/DateTimeDefault.ts:82

Parses a time value from a string if the string matches the given time format.

Parameters:

Name	Type
`timeItems`	string[]
`timeFormat`	Maybe‹string›

Returns: Maybe‹SimpleTime›

defaultStringifyCurrency

▸ defaultStringifyCurrency(_value: number, _formatArg: string): Maybe‹string›

Defined in src/format/format.ts:328

Default implementation of the stringifyCurrency config option.

Returning undefined instructs the formatter to fall through to the built-in number formatter, preserving HyperFormula’s zero-dependency default behavior. Replace this default by setting the stringifyCurrency config option.

Parameters:

Name	Type	Description
`_value`	number	the numeric value to format (unused in default).
`_formatArg`	string	the format string passed to `TEXT` (unused in default).

Returns: Maybe‹string›

undefined — caller should fall through to the built-in formatter.

defaultStringifyDateTime

▸ defaultStringifyDateTime(dateTime: SimpleDateTime, formatArg: string): Maybe‹string›

Defined in src/format/format.ts:224

Default stringifyDateTime callback — formats a date/time value against an Excel-style format string (e.g. YYYY-MM-DD HH:mm:ss).

Returns undefined for format strings that are not date/time formats so the dispatcher in format() can fall through to parseForNumberFormat (or to a user-supplied stringifyCurrency callback for currency-tagged formats).

LCID currency-tag guard — explicitly returns undefined for Excel currency tags [$SYMBOL-LCID] (non-empty SYMBOL portion). Without the guard, parseForDateTimeFormat greedily consumes letters like D/M/S/Y/H inside the currency code (e.g. D in USD, H in CHF, M+D in AMD), mangling the output of an [$USD-409] #,##0.00 format into [$US9-409] #,##0.00 because D is read as a day token. The pre-HF-24 behaviour was to mis-format; the guarded return is the deliberate correction, not a regression. Bit-for-bit compatibility is preserved for every non-currency format (dates, durations, $#,##0.00, etc.).

The guard pattern (/\[\$[^\-\]]+-/) requires ≥1 character between [$ and - so it distinguishes currency tags ([$USD-409], [$€-2]) from Excel’s locale-only modifier ([$-409], [$-F800]), which is valid on date/time formats and must continue to flow through this function.

Parameters:

Name	Type	Description
`dateTime`	SimpleDateTime	parsed date/time value to render
`formatArg`	string	Excel-style format string

Returns: Maybe‹string›

formatted string, or undefined to defer to the next dispatch step

defaultStringifyDuration

▸ defaultStringifyDuration(time: SimpleTime, formatArg: string): Maybe‹string›

Defined in src/format/format.ts:132

Default stringifyDuration callback — formats a duration value against an Excel-style time format string (e.g. [hh]:mm:ss).

Returns undefined for format strings that are not duration formats so the dispatcher in format() can fall through to other handlers.

LCID currency-tag guard — sibling to the same guard in defaultStringifyDateTime; explicitly returns undefined for Excel currency tags [$SYMBOL-LCID] because the SYMBOL portion contains duration-token letters (H in CHF/HUF, m in AMD/HMD) that parseForDateTimeFormat would otherwise interpret as time tokens and mangle the output. See defaultStringifyDateTime for the full symbol-vs-locale-modifier rationale and the historical pre-HF-24 behaviour the guard corrects.

Parameters:

Name	Type	Description
`time`	SimpleTime	parsed duration value to render
`formatArg`	string	Excel-style format string

Returns: Maybe‹string›

formatted string, or undefined to defer to the next dispatch step

doesContainRelativeReferences

▸ doesContainRelativeReferences(ast: Ast): boolean

Defined in src/NamedExpressions.ts:299

Parameters:

Name	Type
`ast`	Ast

Returns: boolean

doesItLookLikeADateTimeQuickCheck

▸ doesItLookLikeADateTimeQuickCheck(text: string): boolean

Defined in src/DateTimeDefault.ts:222

If this function returns false, the string is not parsable as a date time. Otherwise, it might be. This is a quick check that is used to avoid running the more expensive parsing operations.

Parameters:

Name	Type
`text`	string

Returns: boolean

empty

▸ empty‹T›(): IterableIterator‹T›

Defined in src/generatorUtils.ts:8

Type parameters:

▪ T

Returns: IterableIterator‹T›

equalSimpleCellAddress

▸ equalSimpleCellAddress(left: SimpleCellAddress, right: SimpleCellAddress): boolean

Defined in src/Cell.ts:226

Parameters:

Name	Type
`left`	SimpleCellAddress
`right`	SimpleCellAddress

Returns: boolean

extractTime

▸ extractTime(v: any): number

Defined in src/helpers/licenseKeyHelper.ts:16

Parameters:

Name	Type
`v`	any

Returns: number

filterDependenciesOutOfScope

▸ filterDependenciesOutOfScope(deps: CellDependency[]): CellDependency[]

Defined in src/absolutizeDependencies.ts:21

Parameters:

Name	Type
`deps`	CellDependency[]

Returns: CellDependency[]

findBoundaries

▸ findBoundaries(sheet: Sheet): SheetBoundaries

Defined in src/Sheet.ts:49

Returns actual width, height and fill ratio of a sheet

Parameters:

Name	Type	Description
`sheet`	Sheet	two-dimmensional array sheet representation

Returns: SheetBoundaries

findInOrderedArray

▸ findInOrderedArray(key: number, values: number[], handlingMisses: “lowerBound” | “upperBound”): number

Defined in src/Lookup/ColumnIndex.ts:339

Parameters:

Name	Type	Default
`key`	number	-
`values`	number[]	-
`handlingMisses`	”lowerBound” \| “upperBound"	"upperBound”

Returns: number

first

▸ first‹T›(iterable: IterableIterator‹T›): Maybe‹T›

Defined in src/generatorUtils.ts:22

Type parameters:

▪ T

Parameters:

Name	Type
`iterable`	IterableIterator‹T›

Returns: Maybe‹T›

format

▸ format(value: number, formatArg: string, config: Config, dateHelper: DateTimeHelper): RawScalarValue

Defined in src/format/format.ts:28

Parameters:

Name	Type
`value`	number
`formatArg`	string
`config`	Config
`dateHelper`	DateTimeHelper

Returns: RawScalarValue

formatDate

▸ formatDate(date: Date): string

Defined in src/helpers/licenseKeyValidator.ts:91

Formats a Date instance to hard-coded format MMMM DD, YYYY.

Parameters:

Name	Type	Description
`date`	Date	The date to format.

Returns: string

formatToken

▸ formatToken(type: TokenType, value: string): FormatToken

Defined in src/format/parser.ts:21

Parameters:

Name	Type
`type`	TokenType
`value`	string

Returns: FormatToken

getCellType

▸ getCellType(vertex: Maybe‹CellVertex›, address: SimpleCellAddress): CellType

Defined in src/Cell.ts:61

Parameters:

Name	Type
`vertex`	Maybe‹CellVertex›
`address`	SimpleCellAddress

Returns: CellType

getCellValueDetailedType

▸ getCellValueDetailedType(cellValue: InterpreterValue): CellValueDetailedType

Defined in src/Cell.ts:133

Parameters:

Name	Type
`cellValue`	InterpreterValue

Returns: CellValueDetailedType

getCellValueFormat

▸ getCellValueFormat(cellValue: InterpreterValue): string | undefined

Defined in src/Cell.ts:141

Parameters:

Name	Type
`cellValue`	InterpreterValue

Returns: string | undefined

getCellValueType

▸ getCellValueType(cellValue: InterpreterValue): CellValueType

Defined in src/Cell.ts:113

Parameters:

Name	Type
`cellValue`	InterpreterValue

Returns: CellValueType

getDefaultConfig

▸ getDefaultConfig(): ConfigParams

Defined in src/Config.ts:354

Returns: ConfigParams

getFullConfigFromPartial

▸ getFullConfigFromPartial(partialConfig: Partial‹ConfigParams›): ConfigParams

Defined in src/Config.ts:340

Parameters:

Name	Type
`partialConfig`	Partial‹ConfigParams›

Returns: ConfigParams

instanceOfSimpleDate

▸ instanceOfSimpleDate(obj: any): obj is SimpleDate

Defined in src/DateTimeHelper.ts:34

Parameters:

Name	Type
`obj`	any

Returns: obj is SimpleDate

instanceOfSimpleTime

▸ instanceOfSimpleTime(obj: any): obj is SimpleTime

Defined in src/DateTimeHelper.ts:43

Parameters:

Name	Type
`obj`	any

Returns: obj is SimpleTime

invalidSimpleColumnAddress

▸ invalidSimpleColumnAddress(address: SimpleColumnAddress): boolean

Defined in src/Cell.ts:190

Parameters:

Name	Type
`address`	SimpleColumnAddress

Returns: boolean

invalidSimpleRowAddress

▸ invalidSimpleRowAddress(address: SimpleRowAddress): boolean

Defined in src/Cell.ts:181

Parameters:

Name	Type
`address`	SimpleRowAddress

Returns: boolean

isBoolean

▸ isBoolean(text: string): boolean

Defined in src/CellContentParser.ts:81

Parameters:

Name	Type
`text`	string

Returns: boolean

isColOrRowInvalid

▸ isColOrRowInvalid(address: SimpleCellAddress): boolean

Defined in src/Cell.ts:203

Checks if the column or row id is negative.

Parameters:

Name	Type
`address`	SimpleCellAddress

Returns: boolean

isError

▸ isError(text: string, errorMapping: Record‹string, ErrorType›): boolean

Defined in src/CellContentParser.ts:86

Parameters:

Name	Type
`text`	string
`errorMapping`	Record‹string, ErrorType›

Returns: boolean

isEscapeToken

▸ isEscapeToken(token: RegExpExecArray): boolean

Defined in src/format/parser.ts:131

Parameters:

Name	Type
`token`	RegExpExecArray

Returns: boolean

isFormula

▸ isFormula(text: string): boolean

Defined in src/CellContentParser.ts:77

Checks whether string looks like formula or not.

Parameters:

Name	Type	Description
`text`	string	formula

Returns: boolean

isNonnegativeInteger

▸ isNonnegativeInteger(x: number): boolean

Defined in src/CrudOperations.ts:657

Parameters:

Name	Type
`x`	number

Returns: boolean

isPositiveInteger

▸ isPositiveInteger(x: number): boolean

Defined in src/CrudOperations.ts:653

Parameters:

Name	Type
`x`	number

Returns: boolean

isRowOrColumnRange

▸ isRowOrColumnRange(leftCorner: SimpleCellAddress, width: number, height: number): boolean

Defined in src/Operations.ts:1100

Parameters:

Name	Type
`leftCorner`	SimpleCellAddress
`width`	number
`height`	number

Returns: boolean

isSimpleCellAddress

▸ isSimpleCellAddress(obj: unknown): obj is SimpleCellAddress

Defined in src/Cell.ts:214

Checks if the object is a simple cell address.

Parameters:

Name	Type
`obj`	unknown

Returns: obj is SimpleCellAddress

isSimpleCellRange

▸ isSimpleCellRange(val: unknown): val is SimpleCellRange

Defined in src/AbsoluteCellRange.ts:34

Type guard that checks if an object is a valid SimpleCellRange.

Parameters:

Name	Type	Description
`val`	unknown	Value to check

Returns: val is SimpleCellRange

True if and only if the object is a valid SimpleCellRange

matchDateFormat

▸ matchDateFormat(str: string): RegExpExecArray[]

Defined in src/format/parser.ts:39

Parameters:

Name	Type
`str`	string

Returns: RegExpExecArray[]

matchNumberFormat

▸ matchNumberFormat(str: string): RegExpExecArray[]

Defined in src/format/parser.ts:55

Parameters:

Name	Type
`str`	string

Returns: RegExpExecArray[]

memoize

▸ memoize‹T›(fn: function): (Anonymous function)

Defined in src/DateTimeDefault.ts:229

Function memoization for improved performance.

Type parameters:

▪ T

Parameters:

▪ fn: function

▸ (arg: string): T

Parameters:

Name	Type
`arg`	string

Returns: (Anonymous function)

movedSimpleCellAddress

▸ movedSimpleCellAddress(address: SimpleCellAddress, toSheet: number, toRight: number, toBottom: number): SimpleCellAddress

Defined in src/Cell.ts:205

Parameters:

Name	Type
`address`	SimpleCellAddress
`toSheet`	number
`toRight`	number
`toBottom`	number

Returns: SimpleCellAddress

normalizeAddedIndexes

▸ normalizeAddedIndexes(indexes: ColumnRowIndex[]): ColumnRowIndex[]

Defined in src/Operations.ts:1068

Parameters:

Name	Type
`indexes`	ColumnRowIndex[]

Returns: ColumnRowIndex[]

normalizeRemovedIndexes

▸ normalizeRemovedIndexes(indexes: ColumnRowIndex[]): ColumnRowIndex[]

Defined in src/Operations.ts:1037

Parameters:

Name	Type
`indexes`	ColumnRowIndex[]

Returns: ColumnRowIndex[]

numberFormat

▸ numberFormat(tokens: FormatToken[], value: number): RawScalarValue

Defined in src/format/format.ts:78

Parameters:

Name	Type
`tokens`	FormatToken[]
`value`	number

Returns: RawScalarValue

numberToSimpleTime

▸ numberToSimpleTime(arg: number): SimpleTime

Defined in src/DateTimeHelper.ts:304

Parameters:

Name	Type
`arg`	number

Returns: SimpleTime

objectDestroy

▸ objectDestroy(object: any): void

Defined in src/Destroy.ts:6

Parameters:

Name	Type
`object`	any

Returns: void

offsetMonth

▸ offsetMonth(date: SimpleDate, offset: number): SimpleDate

Defined in src/DateTimeHelper.ts:286

Parameters:

Name	Type
`date`	SimpleDate
`offset`	number

Returns: SimpleDate

padLeft

▸ padLeft(number: number | string, size: number): string

Defined in src/format/format.ts:58

Parameters:

Name	Type
`number`	number \| string
`size`	number

Returns: string

padRight

▸ padRight(number: number | string, size: number): string

Defined in src/format/format.ts:66

Parameters:

Name	Type
`number`	number \| string
`size`	number

Returns: string

parse

▸ parse(str: string): FormatExpression

Defined in src/format/parser.ts:121

Parameters:

Name	Type
`str`	string

Returns: FormatExpression

parseDateFormat

▸ parseDateFormat(dateFormat: string): object

Defined in src/DateTimeDefault.ts:206

Parses a date format string into a format object.

Parameters:

Name	Type
`dateFormat`	string

Returns: object

dayItem: number
itemsCount: number
longYearItem: number
monthItem: number
shortYearItem: number

parseForDateTimeFormat

▸ parseForDateTimeFormat(str: string): Maybe‹FormatExpression›

Defined in src/format/parser.ts:96

Parameters:

Name	Type
`str`	string

Returns: Maybe‹FormatExpression›

parseForNumberFormat

▸ parseForNumberFormat(str: string): Maybe‹FormatExpression›

Defined in src/format/parser.ts:109

Parameters:

Name	Type
`str`	string

Returns: Maybe‹FormatExpression›

parseTimeFormat

▸ parseTimeFormat(timeFormat: string): object

Defined in src/DateTimeDefault.ts:186

Parses a time format string into a format object.

Parameters:

Name	Type
`timeFormat`	string

Returns: object

hourItem: number
itemsCount: number
minuteItem: number
secondItem: number

postMortem

▸ postMortem(method: any): (Anonymous function)

Defined in src/Destroy.ts:16

Parameters:

Name	Type
`method`	any

Returns: (Anonymous function)

replacer

▸ replacer(key: string, val: any): any

Defined in src/errors.ts:134

Parameters:

Name	Type
`key`	string
`val`	any

Returns: any

roundToEpsilon

▸ roundToEpsilon(arg: number, epsilon: number): number

Defined in src/DateTimeHelper.ts:299

Parameters:

Name	Type	Default
`arg`	number	-
`epsilon`	number	1

Returns: number

roundToNearestSecond

▸ roundToNearestSecond(arg: number): number

Defined in src/DateTimeHelper.ts:295

Parameters:

Name	Type
`arg`	number

Returns: number

simpleCellAddress

▸ simpleCellAddress(sheet: number, col: number, row: number): SimpleCellAddress

Defined in src/Cell.ts:198

Parameters:

Name	Type
`sheet`	number
`col`	number
`row`	number

Returns: SimpleCellAddress

simpleCellRange

▸ simpleCellRange(start: SimpleCellAddress, end: SimpleCellAddress): object

Defined in src/AbsoluteCellRange.ts:43

Parameters:

Name	Type
`start`	SimpleCellAddress
`end`	SimpleCellAddress

Returns: object

end: SimpleCellAddress
start: SimpleCellAddress

simpleColumnAddress

▸ simpleColumnAddress(sheet: number, col: number): SimpleColumnAddress

Defined in src/Cell.ts:188

Parameters:

Name	Type
`sheet`	number
`col`	number

Returns: SimpleColumnAddress

simpleRowAddress

▸ simpleRowAddress(sheet: number, row: number): SimpleRowAddress

Defined in src/Cell.ts:179

Parameters:

Name	Type
`sheet`	number
`row`	number

Returns: SimpleRowAddress

split

▸ split‹T›(iterable: IterableIterator‹T›): object

Defined in src/generatorUtils.ts:11

Type parameters:

▪ T

Parameters:

Name	Type
`iterable`	IterableIterator‹T›

Returns: object

rest: IterableIterator‹T›
value? : T

timeToNumber

▸ timeToNumber(time: SimpleTime): number

Defined in src/DateTimeHelper.ts:315

Parameters:

Name	Type
`time`	SimpleTime

Returns: number

toBasisEU

▸ toBasisEU(date: SimpleDate): SimpleDate

Defined in src/DateTimeHelper.ts:319

Parameters:

Name	Type
`date`	SimpleDate

Returns: SimpleDate

truncateDayInMonth

▸ truncateDayInMonth(date: SimpleDate): SimpleDate

Defined in src/DateTimeHelper.ts:291

Parameters:

Name	Type
`date`	SimpleDate

Returns: SimpleDate

validateArgToType

▸ validateArgToType(inputValue: any, expectedType: string, paramName: string): void

Defined in src/ArgumentSanitization.ts:81

Parameters:

Name	Type
`inputValue`	any
`expectedType`	string
`paramName`	string

Returns: void

validateAsSheet

▸ validateAsSheet(sheet: Sheet): void

Defined in src/Sheet.ts:33

Parameters:

Name	Type
`sheet`	Sheet

Returns: void

validateNumberToBeAtLeast

▸ validateNumberToBeAtLeast(value: number, paramName: string, minimum: number): void

Defined in src/ArgumentSanitization.ts:34

Parameters:

Name	Type
`value`	number
`paramName`	string
`minimum`	number

Returns: void

validateNumberToBeAtMost

▸ validateNumberToBeAtMost(value: number, paramName: string, maximum: number): void

Defined in src/ArgumentSanitization.ts:40

Parameters:

Name	Type
`value`	number
`paramName`	string
`maximum`	number

Returns: void

Object literals

CellValueDetailedType

▪ CellValueDetailedType: object

Defined in src/Cell.ts:95

CellValueType

▪ CellValueType: object

Defined in src/Cell.ts:92

consoleMessages

▪ consoleMessages: object

Defined in src/helpers/licenseKeyValidator.ts:36

List of all not valid messages which may occur.

expired

▸ expired(__namedParameters: object): string

Defined in src/helpers/licenseKeyValidator.ts:38

Parameters:

▪ __namedParameters: object

Name	Type
`keyValidityDate`	string

Returns: string

invalid

▸ invalid(): string

Defined in src/helpers/licenseKeyValidator.ts:37

Returns: string

missing

▸ missing(): string

Defined in src/helpers/licenseKeyValidator.ts:40

Returns: string

maxDate

▪ maxDate: object

Defined in src/DateTimeHelper.ts:51

day

• day: number = 31

Defined in src/DateTimeHelper.ts:51

month

• month: number = 12

Defined in src/DateTimeHelper.ts:51

year

• year: number = 9999

Defined in src/DateTimeHelper.ts:51