SheetXL - v0.3.20
    Preparing search index...

    Interface IDescriptor

    Contains user information about the function.

    This is locale specific.

    interface IDescriptor {
        getCategory(): string;
        getLinks(): readonly [url: string, text?: string][];
        getName(): string;
        getParameters(): Readonly<
            Record<
                string,
                { defaultValue?: string; description: string; example: string },
            >,
        >;
        getSummary(): string;
        isHidden(): string | boolean;
    }
    Index

    Methods

    getCategory getLinks getName getParameters getSummary isHidden

    Methods

    • A category or group to which the function belongs.

      Returns string

    • An array of links associated with the value.

      Returns readonly [url: string, text?: string][]

    • A overwritten name for the function.

      Returns string

    • Describe each parameter in the function.

      Returns Readonly<
          Record<
              string,
              { defaultValue?: string; description: string; example: string },
          >,
      >

    • A description of the function's purpose and usage.

      Returns string

    • If true the function is available but will not be returned in search results unless hidden is specifically requested. If this is a string it can be used to provide a hidden label.

      Returns string | boolean

      'null'

      This is useful for functions that are unimplemented or deprecated.

    Settings

    Member Visibility

    On This Page

    Methods