@eagleoutice/flowr - v2.13.1
    Preparing search index...

    Interface SignatureQueryResult

    interface SignatureQueryResult {
        ".meta": BaseQueryMeta;
        databases: readonly SignatureDatabaseView[];
        function?: SignatureFunctionView;
        latestOnly?: boolean;
        matchCount?: number;
        matches?: readonly SignatureMatchView[];
        message?: string;
        package?: SignaturePackageView;
        packageCount: number;
        packages?: readonly SignaturePackageMatch[];
        searched?: number;
        shards?: readonly ShardStatus[];
        sourceCount: number;
        suggestions?: readonly string[];
        truncated?: boolean;
    }

    Hierarchy (View Summary)

    Hierarchy-Diagram

    UML class diagram of SignatureQueryResult
    Index

    Properties

    .meta databases function? latestOnly? matchCount? matches? message? package? packageCount packages? searched? shards? sourceCount suggestions? truncated?

    Properties

    ".meta": BaseQueryMeta
    databases: readonly SignatureDatabaseView[]
    function?: SignatureFunctionView

    set when a single function was requested and found

    latestOnly?: boolean

    whether the search covered only the latest version of each package, so historical releases were skipped

    matchCount?: number
    matches?: readonly SignatureMatchView[]

    function hits from a wildcard search

    message?: string

    a not-found / disabled note, with optional near-match suggestions

    package?: SignaturePackageView

    set when a single package was requested and found

    packageCount: number
    packages?: readonly SignaturePackageMatch[]

    package hits from a wildcard package search (no function given)

    searched?: number

    how many functions the search examined against the filters (only interesting when it exceeds the hit count)

    shards?: readonly ShardStatus[]

    per-shard load state of the sharded sources (which shards this session has opened and unpacked); summary only

    sourceCount: number
    suggestions?: readonly string[]
    truncated?: boolean

    whether the match list was capped

    Settings

    Member Visibility

    On This Page

    Properties