Class SigDatabaseSet

ReadonlybaseDir

Readonlymanifest

StaticopenManifest

• openManifest(
      manifestFile: string,
      opts?: SigDbSetOpenOptions,
  ): Promise<SigDatabaseSet>

  Parameters

  • manifestFile: string
  • opts: SigDbSetOpenOptions = {}

  Returns Promise<SigDatabaseSet>

StaticopenManifestSync

• openManifestSync(
      manifestFile: string,
      opts?: SigDbSetOpenOptions,
  ): SigDatabaseSet

  Synchronous openManifest, needing every shard to embed its index (the default for the bundles flowR ships). Shards and dictionaries still decompress lazily.

  Parameters

  • manifestFile: string
  • opts: SigDbSetOpenOptions = {}

  Returns SigDatabaseSet

allShards

• allShards(): MountedShard[]

  open (blocking) and return every shard database with its manifest ref, for whole-set verification

  Returns MountedShard[]

classes

• classes(pkg: string, version?: string): SigClassInfo[] | undefined

  The classes a package version declares and the relations between them (superclasses, slot types, virtual, union) -- LibraryExports.s4Classes, a flat name list, has nowhere to hang this; version defaults to the newest.

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns SigClassInfo[] | undefined

classOwner

• classOwner(className: string, version?: string): string | undefined

  The package OWNING class className (S3: LibraryExports.s3Classes; S4: LibraryExports.s4Classes; S3 wins ties). With a version, every candidate package is scanned at it instead of using the cached reverse index.

  Parameters

  • className: string
  • Optionalversion: string

  Returns string | undefined

close

• close(): void

  Close every opened shard's file descriptor and drop the in-memory caches (opened shards + shared dictionaries), so the (potentially large) dictionary strings can be reclaimed by the GC. Idempotent.

  Returns void

coreVersions

• coreVersions(pkg: string): RVersion[] | undefined

  for a base package, the R versions it was part of core (ascending); undefined otherwise

  Parameters

  • pkg: string

  Returns RVersion[] | undefined

dependencies

• dependencies(pkg: string, version?: string): ResolvedDependency[] | undefined

  Declared dependencies (Depends, Imports, ...) of a package version, with version qualifiers; version defaults to the newest.

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns ResolvedDependency[] | undefined

downloads

• downloads(pkg: string): number

  the download count of the package; O(1) via the hoisted metadata, so no shard has to be unpacked for it

  Parameters

  • pkg: string

  Returns number

functionByName

• functionByName(
      pkg: string,
      name: string,
      version?: string,
  ): DecodedFunction | undefined

  The rich view of a single named function, decoding only it (unlike functions); version defaults to the newest.

  Parameters

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

  Returns DecodedFunction | undefined

functions

• functions(pkg: string, version?: string): DecodedFunction[] | undefined

  Rich per-function view (signatures and call graphs) of a package version; version defaults to the newest.

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns DecodedFunction[] | undefined

has

• has(pkg: string): boolean

  whether the source can resolve the package at all

  Parameters

  • pkg: string

  Returns boolean

hasVersion

• hasVersion(pkg: string, version: string): boolean

  whether any active shard actually carries the given version of a package (not just the package)

  Parameters

  • pkg: string
  • version: string

  Returns boolean

isBaseR

• isBaseR(pkg: string): boolean

  whether this is an R-core / base package (see SigDatabase.isBaseR); O(1) via the hoisted metadata

  Parameters

  • pkg: string

  Returns boolean

isCranVersion

• isCranVersion(pkg: string, version: string): 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

latestVersion

• latestVersion(pkg: string): RVersion | undefined

  the newest version of a package by release date (falling back to the recorded latest, then SemVer order)

  Parameters

  • pkg: string

  Returns RVersion | undefined

lookup

• lookup(pkg: string, version?: string): LibraryExports | undefined

  The export view of a package version; version defaults to the database's newest if omitted.

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns LibraryExports | undefined

packageNames

• packageNames(): string[]

  every package name this source can resolve

  Returns string[]

packagesExporting

• packagesExporting(name: string): readonly string[]

  The packages exporting name, ordered by downloads (descending, ties by name); answered without a reverse index, since a name the database never stores is rejected outright and only blobs that may hold it are decoded.

  Parameters

  • name: string

  Returns readonly string[]

preload

• preload(pkgs?: readonly string[]): Promise<void>

  Warm the shards (and their shared dictionaries) needed for pkgs, or everything when omitted. Afterward, the synchronous query methods, for the latest and historical versions, do no I/O or decompression.

  Parameters

  • Optionalpkgs: readonly string[]

  Returns Promise<void>

preloadShards

• preloadShards(include: (shard: SigDbShardRef) => boolean): Promise<void>

  Warm just the shards matching include, e.g., only the current-tier top shards (the base + most-downloaded packages) to speed up common lookups without paying for the long tail or the history shards. See preload.

  Parameters

  • include: (shard: SigDbShardRef) => boolean

  Returns Promise<void>

releaseDate

• releaseDate(pkg: string, version?: string): Date | undefined

  The release date of a package version, undefined if unknown. Omitted, version defaults to the newest release by recorded date (unlike the queries above, which default to the package's recorded latest).

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns Date | undefined

releaseDates

• releaseDates(pkg: string): VersionRelease[]

  every known release of a package (version + date), ascending, read once from the most complete shard

  Parameters

  • pkg: string

  Returns VersionRelease[]

shardStatus

• shardStatus(): ShardStatus[]

  the on-demand load state (opened + unpacked) of every shard in this set

  Returns ShardStatus[]

sharedDictionary

• sharedDictionary(id: string): SigDict

  load (and cache) a shared dictionary by id, for verification/inspection

  Parameters

  • id: string

  Returns SigDict

sourceOf

• sourceOf(pkg: string, version: string): string | undefined

  the repository a version came from, undefined in bundles that record none

  Parameters

  • pkg: string
  • version: string

  Returns string | undefined

transitiveCallees

• transitiveCallees(
      pkg: string,
      name: string,
      version?: string,
  ): string[] | undefined

  Transitive callees of a function within one package version, expanding the stored local call graphs; version defaults to the newest.

  Parameters

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

  Returns string[] | undefined