SheetXL - v0.3.20
    Preparing search index...

    Interface ParameterTypeJSON

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

    interface ParameterTypeJSON {
        arrayDepth?: number;
        description?: string;
        enums?: string[];
        name: string;
        optional?: boolean;
        range?: "r" | "l" | "a";
        rest?: boolean;
        scalar?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arrayDepth? description? enums? name optional? range? rest? scalar?

    Properties

    arrayDepth?: 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.

    0 if no range is defined, otherwise 1.

    description?: string

    A short description of the value's purpose or expected usage.

    enums?: string[]

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

    false

    name: string

    The name of the parameter.

    optional?: boolean

    Indicates whether the parameter is required.

    true
    range?: "r" | "l" | "a"

    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.

    rest?: boolean

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

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

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

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

    Settings

    Member Visibility

    On This Page

    Properties