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

    Interface SignatureMatchView

    a compact hit from a wildcard function search

    interface SignatureMatchView {
        docUrl?: string;
        exported: boolean;
        file?: string;
        flowrOnly?: boolean;
        line?: number;
        manUrl?: string;
        matchedParameters?: readonly string[];
        name: string;
        package: string;
        parameters?: readonly string[];
        sourceUrl?: string;
        version?: string;
    }
    Index
    docUrl? exported file? flowrOnly? line? manUrl? matchedParameters? name package parameters? sourceUrl? version?
    docUrl?: string

    best-effort documentation link, see SignatureFunctionView.docUrl

    exported: boolean
    file?: string
    flowrOnly?: boolean

    whether the hit comes from flowR's built-in configuration instead of a signature database, which is what a search falls back to when no database records the name (see SignatureFunctionView.flowrOnly). Such a hit states no version, location, or export status: flowR's configuration records none of those.

    line?: number
    manUrl?: string

    link to the .Rd help source at the queried version, see SignatureFunctionView.manUrl

    matchedParameters?: readonly string[]

    the subset of parameters that the --param filter actually matched, so the renderer can highlight them

    name: string
    package: string
    parameters?: readonly string[]

    a preview of the function's parameters (the ones a parameter/required filter matched first), when such a filter is active

    sourceUrl?: string
    version?: string

    Settings
    Member Visibility

    On This Page
    Properties