Interface ReadOnlyFlowrAnalyzerDependenciesContext

ReadonlyfunctionsContext

Readonlyname

getDependencies

• getDependencies(): readonly Readonly<Package>[]

  Get all dependencies known to this context.

  Returns readonly Readonly<Package>[]

getDependency

• getDependency(name: string): Readonly<Package> | undefined

  Get the dependency with the given name, if it exists.

  If the static dependencies have not yet been loaded, this may trigger a resolution step.

  Parameters

  • name: string

    The name of the dependency to get.

  Returns Readonly<Package> | undefined

  The dependency with the given name, or undefined if it does not exist.

inferredVersion

• inferredVersion(name: string): Range | undefined

  The versions a dependency can possibly have, combining everything declared for it (a DESCRIPTION range, an rproject.toml entry, a lockfile pin, ...). undefined if the dependency is unknown, if nothing constrains it, or if the sources contradict each other -- then no version is possible at all.

  For why it is what it is (the individual constraints, or the version the database resolved to), take the Package from getDependency.

  Parameters

  • name: string

    The name of the dependency.

  Returns Range | undefined

loadedSignatureDatabases

• loadedSignatureDatabases(): SigDbLoadedInfo[]

  Metadata of the signature databases the version plugins currently have loaded.

  Returns SigDbLoadedInfo[]

packagesExporting

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

  The names of known packages that export name (from the version plugins' signature databases). Used to hint which library()/:: might be missing for an otherwise-undefined symbol. Empty if no database is available or the signature database is disabled.

  Parameters

  • name: string

  Returns readonly string[]

signatureOf

• signatureOf(id: Identifier, version?: string): DecodedFunction | undefined

  The signature-database entry for the qualified call id (a pkg::fn Identifier) from the first source that has it, resolving the package version from the project's dependency info unless version overrides it. This is the easy way to obtain a function's parameters from a context: pass fn.signature (or signatureParameterNames) to RFunctionCall.matchArgsToParams. undefined if id is unqualified or no loaded source defines it.

  Parameters

  • id: Identifier
  • Optionalversion: string

  Returns DecodedFunction | undefined

signatureSources

• signatureSources(): readonly PackageSignatureSource[]

  The signature sources the version plugins currently have loaded (backs the signature query).

  Returns readonly PackageSignatureSource[]