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

    Interface PackageSignatureSource

    The read interface every package-signature source implements, so a single SigDatabase and a sharded SigDatabaseSet are interchangeable. Queries are synchronous; any decompression/caching happens once during open.

    interface PackageSignatureSource {
        classOwner(className: string, version?: string): string | undefined;
        close(): void;
        coreVersions(pkg: string): RVersion[] | undefined;
        dependencies(
            pkg: string,
            version?: string,
        ): ResolvedDependency[] | undefined;
        functionByName(
            pkg: string,
            name: string,
            version?: string,
        ): DecodedFunction | undefined;
        functions(pkg: string, version?: string): DecodedFunction[] | undefined;
        has(pkg: string): boolean;
        hasVersion(pkg: string, version: string): boolean;
        isBaseR(pkg: string): boolean;
        isCranVersion(pkg: string, version: string): boolean;
        latestVersion(pkg: string): RVersion | undefined;
        lookup(pkg: string, version?: string): LibraryExports | undefined;
        packageNames(): string[];
        releaseDate(pkg: string, version?: string): Date | undefined;
        releaseDates(pkg: string): VersionRelease[];
        transitiveCallees(
            pkg: string,
            name: string,
            version?: string,
        ): string[] | undefined;
    }

    Implemented by

    Index

    Methods

    classOwner close coreVersions dependencies functionByName functions has hasVersion isBaseR isCranVersion latestVersion lookup packageNames releaseDate releaseDates transitiveCallees

    Methods

    • The package that OWNS the class className -- an S3 class (a same-named constructor plus a registered method, see LibraryExports.s3Classes) or an S4 class (exported via exportClasses, see LibraryExports.s4Classes); S3 ownership wins a tie. undefined if none does. Without version, backed by a reverse index over every package's latest version, built once and cached.

      Parameters

      • className: string
      • Optionalversion: string

      Returns string | undefined

    • the rich view of a single function by name, decoding only it (unlike functions, which decodes the whole package)

      Parameters

      • pkg: string
      • name: string
      • Optionalversion: string

      Returns DecodedFunction | undefined

    • whether the source can resolve the package at all

      Parameters

      • pkg: string

      Returns boolean

    • whether the source actually carries the given version of a package (not just the package itself)

      Parameters

      • pkg: string
      • version: string

      Returns boolean

    • whether the package is an R-core / base package (its versions are the R releases it shipped with)

      Parameters

      • pkg: string

      Returns boolean

    • whether a version is a current CRAN release (i.e. not in the package's noncran/removed set)

      Parameters

      • pkg: string
      • version: string

      Returns boolean

    • the release date of a package version (defaulting to the newest release), or undefined if unknown

      Parameters

      • pkg: string
      • Optionalversion: string

      Returns Date | undefined

    • the transitive callees of a function within one package version, expanding the stored local call graphs

      Parameters

      • pkg: string
      • name: string
      • Optionalversion: string

      Returns string[] | undefined

    Settings

    Member Visibility

    On This Page

    Methods