SheetXL - v0.3.20
    Preparing search index...

    Contains metadata about a function declaration, including its name, return type, parameters, and additional documentation.

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

    Methods

    • 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 IFunction.IParameterType[]

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