SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IDeclaration

    The type-system metadata the engine reads to coerce arguments, apply broadcasting, and validate calls before execution. This is separate from IDescriptor, which carries locale-specific user-facing copy.

    interface IDeclaration {
        getMaxArguments(): number;
        getName(): string;
        getParameters(): readonly IParameterType[];
        getReturnType(): IReturnType;
    }
    Index
    getMaxArguments getName getParameters getReturnType

    • The largest number of arguments a call to this function may carry.

      Returns number

      Only meaningful for a VARIADIC function; a fixed parameter list is already its own maximum. The number is the whole CALL's argument count, prefix and optional suffix included, and it is refused where Excel refuses it — at entry, before evaluation.

      Repeating

    • Named of the actual function in code.

      Returns string

      The unique identifier for the function. It has a number of rules:

      • The only characters allowed are: (A-Z, 0-9, _m .)
      • Character casing is ignored and will be converted to upper.
      • At least 2 characters.
      • Must start with a letter (A-Z).
      • Must be globally unique.
      • Must not be a reserved word.
      • Must not be a built-in function.

    • An array of Parameter objects describing the function's parameters.

      Returns readonly IParameterType[]

      If not specified, the function is assumed to be volatile (its output might change even if its inputs haven't).

    • Metadata describing the type and dimensionality of the return value.

      Returns IReturnType

      { type: 'void' }

    Settings
    Member Visibility

    On This Page
    Methods