SheetXL - v0.3.20
    Preparing search index...

    Describes the parameter to a function, including its name, type, whether it's required, and if it's a rest parameter.

    interface IParameterType {
        getArrayDepth(): number;
        getEnums(): readonly string[];
        getName(): string;
        getRangeType(): "r" | "l" | "a";
        getScalarType(): ScalarType;
        isOptional(): boolean;
        isRest(): boolean;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • 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

    • Indicates whether the function requires the address of the calling cell as an input. Cannot be combined with stream.

      Returns readonly string[]

    • The name of the parameter.

      Returns string

    • 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 "r" | "l" | "a"

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

      Returns ScalarType

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

    • Indicates whether the parameter is required.

      Returns boolean

    • Indicates whether the parameter is a rest parameter (accepts multiple arguments).

      Returns boolean

      • A rest parameter can only be the last parameter in a function.
      • If rest is true, the parameter is also considered optional.