# DetailedCellError Class
# Constructors
# constructor
+ new DetailedCellError(error: CellError, value: string, address?: undefined | string): DetailedCellError
Defined in src/CellValue.ts:56 (opens new window)
Parameters:
| Name | Type |
|---|---|
error | CellError |
value | string |
address? | undefined | string |
Returns: DetailedCellError
# Properties
# address OptionalReadonly
• address? : undefined | string
Defined in src/CellValue.ts:61 (opens new window)
# argumentIndex OptionalReadonly
• argumentIndex? : undefined | number
Defined in src/CellValue.ts:56 (opens new window)
The zero-based index of the argument that was rejected, when originFunction names a
function whose own argument coercion produced this error.
undefined whenever the error was not a coercion failure on one of the origin
function's own arguments — including when it came from a nested call (its own
originFunction already claimed it), when it was propagated from elsewhere, or when
the argument was a reference that could not be resolved, which the reference itself
reports. When a function is applied across an array, an element that fails coercion
carries the index alongside the function's own name, like any other coercion failure.
# hasMessage Readonly
• hasMessage: boolean
Defined in src/CellValue.ts:25 (opens new window)
Whether the underlying error carried a message at all.
message collapses "no message" and "an empty message" into ''; this flag
keeps them apart for consumers that need to know whether a cause was stated.
Errors the engine raises while evaluating a formula always carry a message. A
false here means nobody stated a cause: a custom function that did not supply
one, or an error value a user typed straight into a cell, where the cause is the
typing itself and originFunction says so.
# message Readonly
• message: string
Defined in src/CellValue.ts:13 (opens new window)
# originFunction OptionalReadonly
• originFunction? : undefined | string
Defined in src/CellValue.ts:43 (opens new window)
What produced this error.
Usually the function or operator that rejected a value, e.g. 'SUM' or 'divide'.
Errors that exist before any function reads them name what built them instead:
'reference' for a reference that cannot be resolved, 'removed reference' for one
destroyed by removing rows or columns, 'parser' for a formula that could not be
parsed, 'user input' for an error value typed into a cell, and 'literal' for one
written into a formula.
First occurrence wins, so a function that only read the error never replaces that:
=SUM(SQRT(-1)) reports 'SQRT', and =SUM(A2:A99999999999) reports 'reference'.
undefined when nothing produced the error in this sense — #SPILL! and #CYCLE!
arise from the layout of a sheet rather than from evaluating a value.
# type Readonly
• type: ErrorType
Defined in src/CellValue.ts:12 (opens new window)
# value Readonly
• value: string
Defined in src/CellValue.ts:60 (opens new window)
# Methods
# toString
▸ toString(): string
Defined in src/CellValue.ts:70 (opens new window)
Returns: string
# valueOf
▸ valueOf(): string
Defined in src/CellValue.ts:74 (opens new window)
Returns: string