Interface IValueType

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

At least one of Scalar, IRange, or Context must be defined.

interface IValueType {
    getArrayDepth(): number;
    getRangeType(): "a" | "r" | "l";
    getScalarType(): ScalarType;
}

Hierarchy (View Summary)

IValueType
- IFunction.IParameterType
- IFunction.IReturnType

Index

Methods

getArrayDepth 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

getRangeType

getRangeType(): "a" | "r" | "l"
Indicates that the value is a range (multi-cell) structure.
- r: A RangeReference, representing a pointer to sheet coordinates.
- l: A RangeLiteral, representing the actual values in the range.
- a: 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 "a" | "r" | "l"

getScalarType

getScalarType(): ScalarType
Indicates that the value is a single, scalar cell-compatible value.

Returns ScalarType
Remarks
This corresponds to a ScalarType such as Number, Boolean, or String. ScalarType.Null is permitted only for event handler return types.