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

    Interface FunctionDescriptor

    The function's self-describing text, loaded lazily (async) from getDescriptor(). Keyed by name so a stale descriptor (from the previous function) is ignored while the next one loads.

    interface FunctionDescriptor {
        enums?: Readonly<Record<string, IEnumDescription>>;
        name: string;
        params: Readonly<Record<string, { description?: string }>>;
        summary: string;
    }
    Index
    enums? name params summary
    enums?: Readonly<Record<string, IEnumDescription>>

    The copy for each enum a parameter is limited to, keyed by enum id — see IFunction.IDescriptor.getEnums.

    name: string

    The function this descriptor belongs to — must match FunctionHint.name to be shown.

    params: Readonly<Record<string, { description?: string }>>

    Per-parameter descriptions, keyed by parameter name (each field optional — may be absent).

    summary: string

    One-line summary of what the function does.

    Settings
    Member Visibility

    On This Page
    Properties