Type Aliases
LoadResult
type LoadResult = object
Defined in: graph/src/transfer-data/load.ts:73
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
graph
graph: GraphLike
securityArchive
securityArchive: | SecurityArchive | undefined;
specOptions
specOptions: SpecOptionsFilled
TransferData
type TransferData = object
Defined in: graph/src/transfer-data/load.ts:83
A data structure defining a complete graph to be transfered, including extra information to the lockfile such as project info and importers.
Type declaration
importers
importers: object[];
lockfile
lockfile: LockfileData
projectInfo
projectInfo: object
projectInfo.tools?
optional projectInfo.tools: string[];
projectInfo.vltInstalled?
optional projectInfo.vltInstalled: boolean;
securityArchive?
optional securityArchive: any;
Variables
lockfile
const lockfile: object
Defined in: graph/src/browser.ts:13
Type declaration
loadEdges()
loadEdges: (graph, edges, options) => void;
Parameters
graph
edges
options
Returns
void
loadNodes()
loadNodes: (graph, nodes, actual?) => void;
Parameters
graph
nodes
Record
<DepID
,
LockfileNode
>
actual?
Returns
void
longDependencyTypes
const longDependencyTypes: Set<DependencyTypeLong>
Defined in: types/src/index.ts:1183
A set of the possible long dependency type names, as used in
package.json
files.
transfer
const transfer: object
Defined in: graph/src/browser.ts:18
Type declaration
load()
load: transfered => LoadResult
Parameters
transfered
Returns
References
asDependencyTypeShort
Re-exports asDependencyTypeShort
getBooleanFlagsFromNum
Re-exports getBooleanFlagsFromNum
shorten
Re-exports shorten
stringifyNode
Re-exports stringifyNode