Class SigDatabase

Readonlycontent

Readonlyindex

Readonlystrings

StaticfromMemory

• fromMemory(db: SigDb): SigDatabase

  Use an already-built SigDb directly, no file involved: its blobs start out in the cache, so a test needs only SigDbBuilder plus this.

  Parameters

  • db: SigDb

  Returns SigDatabase

Staticopen

• open(source: string, opts?: SigDbOpenOptions): Promise<SigDatabase>

  open a .sigs.ndjson, .br or .gz; compressed sources are decompressed into a hash-keyed cache once

  Parameters

  • source: string
  • opts: SigDbOpenOptions = {}

  Returns Promise<SigDatabase>

StaticopenSync

• openSync(plainFile: string, opts?: OpenSyncOptions): SigDatabase

  Open a plain, seekable .sigs.ndjson synchronously (one ranged read, no readline overhead). Pass index to skip reading the .idx, and strings to use an already-loaded shared dictionary (for a blob-only shard).

  Parameters

  • plainFile: string
  • opts: OpenSyncOptions = {}

  Returns SigDatabase

StaticopenSyncFrom

• openSyncFrom(source: string, opts: OpenSyncFromOptions): SigDatabase

  Like open but fully synchronous (blocking decompression); a hash keys the cache when source is compressed. Pass strings for a blob-only shard that shares an already-loaded dictionary.

  Parameters

  • source: string
  • opts: OpenSyncFromOptions

  Returns SigDatabase

allBlobs

• allBlobs(): PkgBlob[]

  read every unique package blob in index order (used to re-hash a whole shard during verification)

  Returns PkgBlob[]

blob

• blob(pkg: string): PkgBlob | undefined

  load a single package's blob by seeking to its line (undefined if absent); cached by blob index

  Parameters

  • pkg: string

  Returns PkgBlob | undefined

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 the underlying file descriptor (idempotent; safe to call more than once)

  Returns void

contentHash

• contentHash(blobs?: PkgBlob[]): string

  recompute this bundle's self-contained content hash from its re-read data (matches writeSignatureDb)

  Parameters

  • blobs: PkgBlob[] = ...

  Returns string

coreVersions

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

  the R versions a base package was part of core, ascending (exactly its stored versions); undefined for a non-base package

  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 recorded for the package, 0 when this source does not carry it

  Parameters

  • pkg: string

  Returns number

dropBlob

• dropBlob(blobIdx: number): void

  drop one decoded blob, for the shared budget to reclaim what it costs (see keepBlob)

  Parameters

  • blobIdx: number

  Returns void

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 this bundle 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 (its versions are the R releases it shipped with; see SigDbPkgMeta)

  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[]

releaseDate

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

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

  Parameters

  • pkg: string
  • Optionalversion: string

  Returns Date | undefined

releaseDates

• releaseDates(pkg: string): VersionRelease[]

  every known release date of a package, in ascending R-version order (empty when no dates were stored)

  Parameters

  • pkg: string

  Returns VersionRelease[]

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