vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • browser
    • index
    • Reference
  • Type Aliases
  • LoadResult
  • TransferData
  • Variables
  • lockfile
  • longDependencyTypes
  • transfer
  • References
  • asDependencyTypeShort
  • createVirtualRoot
  • getBooleanFlagsFromNum
  • shorten
  • stringifyNode
  • VIRTUAL_ROOT_ID
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/graph
  6. /
  7. browser

browser

Type Aliases

LoadResult

TypeScript
type LoadResult = object;

Defined in: graph/src/transfer-data/load.ts:87

The returned object when loading a graph from a transfer data structure, including the graph itself, the spec options used to create it, and the security archive (if any).

Type declaration

NameType
graphGraphLike
securityArchive| SecurityArchive | undefined
specOptionsSpecOptionsFilled

TransferData

TypeScript
type TransferData = object;

Defined in: graph/src/transfer-data/load.ts:97

A data structure defining a complete graph to be transfered, including extra information to the lockfile such as project info and importers.

Type declaration

NameType
importersobject[]
lockfileLockfileData
projectInfoobject
projectInfo.homedirRelativeRootstring
projectInfo.rootstring
projectInfo.tools?string[]
projectInfo.vltInstalled?boolean
securityArchive?any

Variables

lockfile

TypeScript
const lockfile: object;

Defined in: graph/src/browser.ts:15

Type declaration

NameType
loadEdges(graph, edges, options, cache?) => void
loadNodes(graph, nodes, options, actual?, throwOnMissingManifest?) => void

longDependencyTypes

TypeScript
const longDependencyTypes: Set<DependencyTypeLong>;

Defined in: types/src/index.ts:1521

A set of the possible long dependency type names, as used in package.json files.


transfer

TypeScript
const transfer: object;

Defined in: graph/src/browser.ts:20

Type declaration

NameType
load(transfered) => LoadResult

References

asDependencyTypeShort

Re-exports asDependencyTypeShort

createVirtualRoot

Re-exports createVirtualRoot

getBooleanFlagsFromNum

Re-exports getBooleanFlagsFromNum

shorten

Re-exports shorten

stringifyNode

Re-exports stringifyNode

VIRTUAL_ROOT_ID

Re-exports VIRTUAL_ROOT_ID


Previous@vltpkg/graphNextindex

On this page

  • Type Aliases
  • LoadResult
  • TransferData
  • Variables
  • lockfile
  • longDependencyTypes
  • transfer
  • References
  • asDependencyTypeShort
  • createVirtualRoot
  • getBooleanFlagsFromNum
  • shorten
  • stringifyNode
  • VIRTUAL_ROOT_ID

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now