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

    Interface SearchOptions

    Options for searching a function in the collection.

    interface SearchOptions {
        category?: string;
        includeBuiltIn?: boolean;
        includeDeprecated?: boolean;
        limit?: number;
        moduleName?: string;
        name?: string;
        text?: string;
        type?: string;
    }

    Hierarchy (View Summary)

    Index
    category? includeBuiltIn? includeDeprecated? limit? moduleName? name? text? type?
    category?: string

    Search with the given name. This is case insensitive.

    includeBuiltIn?: boolean
    includeDeprecated?: boolean

    Include functions their descriptor marks deprecated (or hidden).

    false — but only where it can be read; see the remarks.

    Deprecation lives in the descriptor (IFunction.IDescriptor.isDeprecated), so honoring this means loading descriptors. To keep a name/type lookup free, the filter applies only when the search is already reading them — with text or category, or when this option is passed EXPLICITLY (either value forces the read).

    limit?: number

    Return at most this many functions.

    Applied AFTER ordering, so a limited search is the top N by relevance — not an arbitrary N. A search box wanting "the best 50 of 400" should use this rather than slicing the result, so the caller never pays to materialize the rest.

    moduleName?: string
    name?: string

    Search with the given name. This is case insensitive.

    Optionaltext

    text?: string

    Search all function descriptors for the given text. This is case insensitive.

    If this is specified this will also search the name.

    type?: string

    Settings
    Member Visibility

    On This Page
    Properties