Interface IValueType

Describes the type characteristics of a value used as a function parameter or return value.

Remarks

If getScalarType is null and getRangeType is null, the value is untyped. Not all runtimes will allow this.

interface IValueType {
    getArrayDepth(): number;
    getLambda(): ScalarType | "*" | "raw" | null;
    getRangeType(): "*" | "p" | "r" | "m" | null;
    getScalarType(): ScalarType | "*" | null;
}

Hierarchy (View Summary)

IValueType
- IParameterType
- IReturnType

Index

Methods

getArrayDepth getLambda getRangeType getScalarType

Methods

getArrayDepth

getArrayDepth(): number
Defines the number of array signatures after a parameter.
- 0: No array signature. The value is scalar or a single cell.
- 1: Will flatten.
- 2: Nest.
Returns number

getLambda

getLambda(): ScalarType | "*" | "raw" | null
Indicates that the value is a LAMBDA (a function value), and what it produces — which is also what the marshalled callable coerces each result to.
- '*': any SCALAR — each result coerces to one scalar.
- a ScalarType: the lambda's declared return.
- 'raw': a declared any return — results pass uncoerced (REDUCE's accumulator).
- null: not a lambda.
Returns ScalarType | "*" | "raw" | null

Remarks
A lambda is neither a value nor a location, so this is the accessor to ask before concluding anything from getScalarType — which reports 'l' alongside a lambda for historical reasons, a spelling outside its own declared ScalarType | '*' | null.

Applies to both parameters (BYROW's fn) and the one return that is a lambda (LAMBDA).

getRangeType

getRangeType(): "*" | "p" | "r" | "m" | null
Indicates that the value is a range (multi-cell) structure.
- p: A RangeReference, representing a pointer to sheet coordinates.
- r: A Range, representing the actual values in the range.
- m: A materialized array (Scalar[] or Scalar[][]) that has been extracted from the range.
If specified, the function supports multi-cell or structured range inputs.
Returns "*" | "p" | "r" | "m" | null

getScalarType

getScalarType(): ScalarType | "*" | null

Indicates that the value is a single, scalar cell-compatible value.

Returns ScalarType | "*" | null

Remarks
This corresponds to a ScalarType such as Number, Boolean, or String. '*' is a scalar of undeclared type — still provably a scalar, unlike untyped. ScalarType.Null is permitted only for event handler return types.