Skip to content
docs | vlt

index | @vltpkg/graph

Classes

Edge

Implements

Constructors

new Edge()
new Edge(
   type,
   spec,
   from,
   to?): Edge
Parameters

• type: DependencyTypeShort

• spec: Spec

• from: Node

• to?: Node

Returns

Edge

Defined in

edge.ts:48

Properties

from
from: Node

The Node this Edge is connecting from, this is usually the dependent.

Implementation of

EdgeLike.from

Defined in

edge.ts:31

spec
spec: Spec

The defined spec value for to as parsed from the dependent metadata.

Implementation of

EdgeLike.spec

Defined in

edge.ts:46

to?
optional to: Node;

The node this Edge is connecting to, this is usually a direct dependency.

Implementation of

EdgeLike.to

Defined in

edge.ts:36

type
type: DependencyTypeShort

What type of dependency relationship from and to nodes have.

Implementation of

EdgeLike.type

Defined in

edge.ts:41

Accessors

[toStringTag]
get toStringTag: string
Returns

string

Defined in

edge.ts:11

dev
get dev(): boolean

This edge was defined as part of a devDependencies in package.json

Returns

boolean

Defined in

edge.ts:70

name
get name(): string

The name of the dependency to as defined in the dependent metadata.

Returns

string

Implementation of

EdgeLike.name

Defined in

edge.ts:63

optional
get optional(): boolean
Returns

boolean

Defined in

edge.ts:74

peer
get peer(): boolean
Returns

boolean

Defined in

edge.ts:78

peerOptional
get peerOptional(): boolean
Returns

boolean

Defined in

edge.ts:82

Methods

[kCustomInspect]()
kCustomInspect: string
Parameters

• _: number

• options: InspectOptions

Returns

string

Defined in

edge.ts:15

valid()
valid(): boolean
Returns

boolean

Defined in

edge.ts:86

Graph

Implements

Constructors

new Graph()
new Graph(options): Graph
Parameters

• options: GraphOptions

Returns

Graph

Defined in

graph.ts:108

Properties

edges
edges: Set<Edge>

A set of all edges in this graph.

Implementation of

GraphLike.edges

Defined in

graph.ts:66

extraneousDependencies
extraneousDependencies: Set<Edge>

A set of extraneous dependencies found when building the graph.

Defined in

graph.ts:101

importers
importers: Set<Node>

A set of importer nodes in this graph.

Implementation of

GraphLike.importers

Defined in

graph.ts:91

mainImporter
mainImporter: Node

The Node that represents the project root package.json.

Implementation of

GraphLike.mainImporter

Defined in

graph.ts:96

manifests
manifests: ManifestInventory

An inventory with all manifests related to an install.

Defined in

graph.ts:61

monorepo?
optional monorepo: Monorepo;

A Monorepo instance, used for managing workspaces.

Defined in

graph.ts:56

nodes
nodes: Map<DepID, Node>

Map registered dep ids to the node that represent them in the graph.

Implementation of

GraphLike.nodes

Defined in

graph.ts:71

nodesByName
nodesByName: Map<string, Set<Node>>

Map of nodes by their name

Defined in

graph.ts:76

projectRoot
projectRoot: string

The root of the project this graph represents

Implementation of

GraphLike.projectRoot

Defined in

graph.ts:106

resolutions
resolutions: Map<string, Node>

Cached resolutions for spec lookups

Defined in

graph.ts:81

resolutionsReverse
resolutionsReverse: Map<Node, Set<string>>

Reverse map of resolutions

Defined in

graph.ts:86

Accessors

[toStringTag]
get toStringTag: string
Returns

string

Defined in

graph.ts:45

Methods

[kCustomInspect]()
kCustomInspect: string
Parameters

• _: number

• options: InspectOptions

Returns

string

Defined in

graph.ts:409

addEdge()
addEdge(
   type,
   spec,
   from,
   to?): Edge

Create a new edge between two nodes of the graph in case both exist, in case the destination node does not exists, then a dangling edge, pointing to nothing will be created to represent that missing dependency.

Parameters

• type: DependencyTypeShort

• spec: Spec

• from: NodeLike

• to?: NodeLike

Returns

Edge

Implementation of

GraphLike.addEdge

Defined in

graph.ts:190

addNode()
addNode(
   id?,
   manifest?,
   spec?,
   name?,
   version?): Node

Create a new node in the graph.

Parameters

• id?: DepID

• manifest?: Manifest

• spec?: Spec

• name?: string

• version?: string

Returns

Node

Implementation of

GraphLike.addNode

Defined in

graph.ts:263

findResolution()
findResolution(spec, fromNode): undefined | Node

Find an existing node to satisfy a dependency

Parameters

• spec: Spec

• fromNode: Node

Returns

undefined | Node

Defined in

graph.ts:232

gc()
gc(): Map<DepID, Node>

Delete all nodes that are unreachable from the importers. The collection of deleted nodes is returned.

NOTE: This can be extremely slow for large graphs, and is almost always unnecessary! Only call when it is known that some unreachable nodes may have been created, for example when deleting the unneeded subgraph when an optional node fails to resolve/install.

Returns

Map<DepID, Node>

Defined in

graph.ts:164

placePackage()
placePackage(
   fromNode,
   depType,
   spec,
   manifest?,
   id?): undefined | Node

Place a new package into the graph representation, creating the new edges and possibly new nodes that are to be expected when traversing the graph in a top-down direction, e.g: from importers to leafs.

For different uses that are not a direct top-down traversal of the graph consider using addNode() and addEdge() instead.

Parameters

• fromNode: Node

• depType: DependencyTypeShort

• spec: Spec

• manifest?: Manifest

• id?: DepID

Returns

undefined | Node

Defined in

graph.ts:307

removeNode()
removeNode(node, replacement?): void

Removes a node and its relevant edges from the graph.

If a replacement is provided, then any edges that were previously pointing to the removed node will be directed to the replacement, if it is valid to do so.

Parameters

• node: Node

• replacement?: Node

Returns

void

Defined in

graph.ts:369

toJSON()
toJSON(): LockfileData
Returns

LockfileData

Defined in

graph.ts:401

Node

Implements

Constructors

new Node()
new Node(
   options,
   id?,
   manifest?,
   spec?,
   name?,
   version?): Node
Parameters

• options: NodeOptions

• id?: DepID

• manifest?: Manifest

• spec?: Spec

• name?: string

• version?: string

Returns

Node

Defined in

node.ts:196

Properties

edgesIn
edgesIn: Set<Edge>

List of edges coming into this node.

Implementation of

NodeLike.edgesIn

Defined in

node.ts:84

edgesOut
edgesOut: Map<string, Edge>

List of edges from this node into other nodes. This usually represents that the connected node is a direct dependency of this node.

Implementation of

NodeLike.edgesOut

Defined in

node.ts:90

graph
graph: GraphLike

A reference to the graph this node is a part of.

Implementation of

NodeLike.graph

Defined in

node.ts:110

id
id: DepID

A reference to the DepID this node represents in the graph.

Implementation of

NodeLike.id

Defined in

node.ts:95

importer
importer: boolean = false

True if this node is an importer node.

Implementation of

NodeLike.importer

Defined in

node.ts:100

integrity?
optional integrity: `sha512-${string}`;

The manifest integrity value.

Implementation of

NodeLike.integrity

Defined in

node.ts:115

mainImporter
mainImporter: boolean = false

True if this node is the project root node.

Implementation of

NodeLike.mainImporter

Defined in

node.ts:105

manifest?
optional manifest: Manifest;

The manifest this node represents in the graph.

Implementation of

NodeLike.manifest

Defined in

node.ts:120

projectRoot
projectRoot: string

Project where this node resides

Implementation of

NodeLike.projectRoot

Defined in

node.ts:125

registry?
optional registry: string;

For registry nodes, this is the registry we fetched them from. Needed because their un-prefixed dependencies need to come from the same registry, if it’s not the default.

Defined in

node.ts:132

resolved?
optional resolved: string;

An address PackageInfoClient may use to extract this package.

Implementation of

NodeLike.resolved

Defined in

node.ts:173

version?
optional version: string;

The version of the package represented by this node, this is usually equivalent to manifest.version but in a few ways it may differ such as nodes loaded from a lockfile that lacks a loaded manifest. This field should be used to retrieve package versions instead.

Implementation of

NodeLike.version

Defined in

node.ts:168

Accessors

[toStringTag]
get toStringTag: string
Returns

string

Defined in

node.ts:23

dev
get dev(): boolean

True if a node is only reachable via dev edges from any importer.

Setting this to false, if previously set to true, will also unset the flag on any dev-flagged non-dev dependencies.

set dev(dev): void
Parameters

• dev: boolean

Returns

boolean

Implementation of

NodeLike.dev

Defined in

node.ts:63

location
get location(): string

The file system location for this node.

set location(location): void
Parameters

• location: string

Returns

string

Implementation of

NodeLike.location

Defined in

node.ts:178

name
get name(): string
Returns

string

Implementation of

NodeLike.name

Defined in

node.ts:141

nodeModules
get nodeModules(): string

The location of the node_modules folder where this node’s edgesOut should be linked into. For nodes in the store, this is the parent directory, since they’re extracted into a node_modules folder side by side with links to their deps. For nodes outside of the store (ie, importers and arbitrary link deps) this is the node_modules folder directly inside the node’s directory.

Returns

string

Defined in

node.ts:155

optional
get optional(): boolean

True if a node is only reachable via optional or peerOptional edges from any importer.

Setting this to false, if previously set to true, will also unset the flag on any optional-flagged non-optional dependencies.

set optional(optional): void
Parameters

• optional: boolean

Returns

boolean

Implementation of

NodeLike.optional

Defined in

node.ts:38

Methods

addEdgesTo()
addEdgesTo(
   type,
   spec,
   node?): Edge

Add an edge from this node connecting it to a direct dependency.

Parameters

• type: DependencyTypeShort

• spec: Spec

• node?: Node

Returns

Edge

Defined in

node.ts:298

equals()
equals(other): boolean
Parameters

• other: Node

Returns

boolean

Defined in

node.ts:248

inVltStore()
inVltStore(): boolean

return true if this node is located in the vlt store memoized the first time it’s called, since the store location doesn’t change within the context of a single operation.

Returns

boolean

Defined in

node.ts:230

isDev()
isDev(): this is Node & Object
Returns

this is Node & Object

Defined in

node.ts:77

isOptional()
isOptional(): this is Node & Object
Returns

this is Node & Object

Defined in

node.ts:52

setDefaultLocation()
setDefaultLocation(): void
Returns

void

Defined in

node.ts:281

setImporterLocation()
setImporterLocation(location): void

Sets the node as an importer along with its location.

Parameters

• location: string

Returns

void

Defined in

node.ts:255

setResolved()
setResolved(): void

Sets the appropriate resolve / integrity value for this node. Note that other places might also set these values, like for example the lockfile that might have already have this info.

Returns

void

Defined in

node.ts:265

toJSON()
toJSON(): object
Returns

object

dev
dev: boolean
id
id: DepID
importer
importer: boolean
integrity
integrity: undefined | `sha512-${string}`
location
location: string
manifest
manifest: undefined | Manifest
name
name: string
optional
optional: boolean
projectRoot
projectRoot: string
resolved
resolved: undefined | string
version
version: undefined | string
Defined in

node.ts:305

toString()
toString(): string

Returns a string representation of an object.

Returns

string

Defined in

node.ts:321

Type Aliases

ActualLoadOptions

type ActualLoadOptions: SpecOptions & object;

Type declaration

loadManifests?
optional loadManifests: boolean;

If set to false, actual.load will not load any package.json files while traversing the file system.

The resulting Graph from loading with loadManifests=false has no information on dependency types or the specs defined and no information on missing and extraneous dependencies.

mainManifest?
optional mainManifest: Manifest;

The project root manifest.

monorepo?
optional monorepo: Monorepo;

A Monorepo object, for managing workspaces

packageJson
packageJson: PackageJson

A PackageJson object, for sharing manifest caches

projectRoot
projectRoot: string

The project root dirname.

scurry
scurry: PathScurry

A PathScurry object, for use in globs

skipHiddenLockfile?
optional skipHiddenLockfile: boolean;

If set to true, then do not shortcut the process by reading the hidden lockfile at node_modules/.vlt-lock.json

Defined in

actual/load.ts:21

AddImportersDependenciesMap

type AddImportersDependenciesMap: Map<DepID, Map<string, Dependency>>;

A Map in which keys are DepID linking to another Map in which keys are the dependency names and values are Dependency. This structure represents dependencies that need to be added to the importer represented by DepID.

Defined in

dependencies.ts:72

BuildIdealOptions

type BuildIdealOptions: ActualLoadOptions & object;

Type declaration

add?
optional add: AddImportersDependenciesMap;

A Map in which keys are DepID linking to another Map in which keys are the dependency names and values are Dependency. This structure represents dependencies that need to be added to the importer represented by DepID.

packageInfo
packageInfo: PackageInfoClient

A PackageInfoClient instance to read manifest info from.

remove?
optional remove: RemoveImportersDependenciesMap;

A Map object representing nodes to be removed from the ideal graph. Each DepID key represents an importer node and the Set of dependency names to be removed from its dependency list.

Defined in

ideal/build.ts:19

Dependency

type Dependency: object;

Parsed dependency entries info.

Type declaration

spec
spec: Spec

The parsed Spec object describing the dependency requirements.

type
type: DependencyTypeShort

The DependencyTypeShort, describing the type of dependency.

Defined in

dependencies.ts:55

DependencyTypeLong

type DependencyTypeLong: "dependencies" | "devDependencies" | "optionalDependencies" | "peerDependencies";

Name of the package.json keys used to define different types of dependencies.

Defined in

dependencies.ts:9

DependencyTypeShort

type DependencyTypeShort:
  | "dev"
  | "optional"
  | "peer"
  | "peerOptional"
  | "prod";

Unique keys that define different types of dependencies relationship.

Defined in

dependencies.ts:18

EdgeLike

type EdgeLike: object;

Type declaration

from
from: NodeLike
name
name: string
spec
spec: SpecLikeBase
to?
optional to: NodeLike;
type
type: DependencyTypeShort

Defined in

types.ts:6

EdgeMap

type EdgeMap: Map<NodeLike | undefined, TreeItem>;

Defined in

visualization/human-readable-output.ts:35

GraphLike

type GraphLike: object;

Type declaration

addEdge()
addEdge: (type, spec, from, to?) => EdgeLike
Parameters

• type: DependencyTypeShort

• spec: Spec

• from: NodeLike

• to?: NodeLike

Returns

EdgeLike

addNode()
addNode: (id?, manifest?, spec?, name?, version?) => NodeLike
Parameters

• id?: DepID

• manifest?: Manifest

• spec?: Spec

• name?: string

• version?: string

Returns

NodeLike

edges
edges: Set<EdgeLike>
importers
importers: Set<NodeLike>
mainImporter
mainImporter: NodeLike
nodes
nodes: Map<DepID, NodeLike>
projectRoot
projectRoot: string

Defined in

types.ts:14

GraphOptions

type GraphOptions: SpecOptions & object;

Type declaration

mainManifest
mainManifest: Manifest

The main importer manifest info.

manifests?
optional manifests: ManifestInventory;

An inventory of seen manifests.

monorepo?
optional monorepo: Monorepo;

A Monorepo object, for managing workspaces

projectRoot
projectRoot: string

Root of the project this graph represents

Defined in

graph.ts:25

HumanReadableOutputOptions

type HumanReadableOutputOptions: object;

Type declaration

colors?
optional colors: ChalkInstance;
edges
edges: EdgeLike[];
highlightSelection
highlightSelection: boolean
importers
importers: Set<NodeLike>
nodes
nodes: NodeLike[];

Defined in

visualization/human-readable-output.ts:27

JSONOutputItem

type JSONOutputItem: object;

A JSON output item describes a package that is present in the install graph. It represents an edge plus it’s linking Node.

Type declaration

fromID?
optional fromID: DepID;

A reference to the id of the Node that this package is linked from.

name
name: string

The name of the package.

spec?
optional spec: string;

The dependency spec definition for this package.

to?
optional to: NodeLike;

A representation of the package object that fulfills this dependency.

type?
optional type: EdgeLike["type"];

The package type.

Defined in

visualization/json-output.ts:8

JSONOutputOptions

type JSONOutputOptions: object;

Type declaration

edges
edges: EdgeLike[];
nodes
nodes: NodeLike[];

Defined in

visualization/json-output.ts:31

LockfileData

type LockfileData: object;

This is the main type definition for the contents of the vlt-lock.json file.

The nodes and edges information from the lockfile are used to reconstruct a Graph representing a previous install.

Type declaration

edges
edges: LockfileEdges
nodes
nodes: Record<DepID, LockfileNode>
options
options: SpecOptions

Defined in

lockfile/types.ts:14

LockfileEdgeKey

type LockfileEdgeKey: `${DepID} ${string}`;

${from} ${dep name}

Defined in

lockfile/types.ts:70

LockfileEdges

type LockfileEdges: object;

Lockfile edges are stored as a record object where the key is ${from.id} ${spec.name} and the value is ${type} ${spec.bareSpec} ${to.id | 'MISSING'}

Storing them in a record like this means that we are guaranteed to never end up with duplicates, and a standard JSON.stringify() will nicely print them out one line per edge.

Index Signature

[key: LockfileEdgeKey]: LockfileEdgeValue

Defined in

lockfile/types.ts:65

LockfileEdgeValue

type LockfileEdgeValue: `${DependencyTypeShort} ${Spec["bareSpec"]} ${DepID | "MISSING"}`;

${type} ${spec} ${to}

Defined in

lockfile/types.ts:73

LockfileLoadOptions

type LockfileLoadOptions: SpecOptions & object;

Type declaration

mainManifest
mainManifest: Manifest

The project root manifest.

monorepo?
optional monorepo: Monorepo;

A Monorepo object, for managing workspaces

packageJson?
optional packageJson: PackageJson;

A PackageJson object, for sharing manifest caches

projectRoot
projectRoot: string

The project root dirname.

scurry?
optional scurry: PathScurry;

A PathScurry object, for use in globs

Defined in

lockfile/load.ts:13

LockfileNode

type LockfileNode: [LockfileNodeFlags, string | null, Integrity | null, string | null, string | null, Manifest | null];

Lockfile representation of a node from the install graph.

Defined in

lockfile/types.ts:47

LockfileNodeFlags

type LockfileNodeFlags: 0 | 1 | 2 | 3;

Bit flags indicating whether a node is optional and/or dev.

Defined in

lockfile/types.ts:42

ManifestInventory

type ManifestInventory: Map<DepID, Manifest>;

Defined in

graph.ts:20

MermaidOutputOptions

type MermaidOutputOptions: object;

Type declaration

edges
edges: EdgeLike[];
importers
importers: Set<NodeLike>
nodes
nodes: NodeLike[];

Defined in

visualization/mermaid-output.ts:6

NodeLike

type NodeLike: object;

Type declaration

dev
dev: boolean
edgesIn
edgesIn: Set<EdgeLike>
edgesOut
edgesOut: Map<string, EdgeLike>
graph
graph: GraphLike
id
id: DepID
importer
importer: boolean
integrity?
optional integrity: string | null;
location?
optional location: string;
mainImporter
mainImporter: boolean
manifest?
optional manifest: Manifest | null;
name?
optional name: string | null;
optional
optional: boolean
projectRoot
projectRoot: string
resolved?
optional resolved: string | null;
version?
optional version: string | null;

Defined in

types.ts:35

NodeOptions

type NodeOptions: SpecOptions & object;

Type declaration

graph
graph: GraphLike
projectRoot
projectRoot: string

Defined in

node.ts:17

RawDependency

type RawDependency: object;

Dependency entries info as defined in a package.json file.

Type declaration

bareSpec
bareSpec: string
name
name: string
registry?
optional registry: string;
type
type: DependencyTypeLong

Defined in

dependencies.ts:45

ReifyOptions

type ReifyOptions: ActualLoadOptions & object;

Type declaration

actual?
optional actual: Graph;
add?
optional add: AddImportersDependenciesMap;
graph
graph: Graph
packageInfo
packageInfo: PackageInfoClient
remove?
optional remove: RemoveImportersDependenciesMap;

Defined in

reify/index.ts:34

RemoveImportersDependenciesMap

type RemoveImportersDependenciesMap: Map<DepID, Set<string>>;

A Map object representing nodes to be removed from the ideal graph. Each DepID key represents an importer node and the Set of dependency names to be removed from its dependency list.

Defined in

dependencies.ts:82

SaveOptions

type SaveOptions: SpecOptions & object;

Type declaration

graph
graph: Graph

The graph to be stored in the lockfile.

saveManifests?
optional saveManifests: boolean;

Should it save manifest data in the lockfile?

Defined in

lockfile/save.ts:24

TreeItem

type TreeItem: object;

Type declaration

deduped
deduped: boolean
edge
edge: EdgeLike | undefined
hasSibling
hasSibling: boolean
include
include: boolean
name?
optional name: string | null;
node
node: NodeLike | undefined
padding
padding: string
parent
parent: TreeItem | undefined
prefix
prefix: string

Defined in

visualization/human-readable-output.ts:15

TreeMap

type TreeMap: Map<EdgeLike | undefined, EdgeMap>;

Defined in

visualization/human-readable-output.ts:37

Variables

actual

const actual: object

Type declaration

load()
load: options => (Graph = actualLoad)

Read the file system looking for node_modules folders and returns a new Graph that represents the relationship between the dependencies found.

Parameters

• options: ActualLoadOptions

Returns

Graph

Defined in

index.ts:16

dependencyTypes

const dependencyTypes: Map<DependencyTypeLong, DependencyTypeShort>

Maps between long form names usually used in package.json files to a corresponding short form name, used in lockfiles.

Defined in

dependencies.ts:128

ideal

const ideal: object

Type declaration

build()
build: options => Promise<Graph>

Builds an ideal Graph representing the dependencies that should be present in order to fulfill the requirements defined by the package.json and vlt-lock.json files using either the virtual or actual graph as a starting point. Also add / remove any dependencies listed in the add and remove properties.

Parameters

• options: BuildIdealOptions

Returns

Promise<Graph>

Defined in

index.ts:37

lockfile

const lockfile: object

Type declaration

load()
load: options => (Graph = lockfileLoad)
Parameters

• options: LockfileLoadOptions

Returns

Graph

loadEdges()
loadEdges: (graph, edges, options) => void;
Parameters

• graph: GraphLike

• edges: LockfileEdges

• options: SpecOptions

Returns

void

loadNodes()
loadNodes: (graph, nodes) => void;
Parameters

• graph: GraphLike

• nodes: Record<DepID, LockfileNode>

Returns

void

save()
save: (options) => void;
Parameters

• options: SaveOptions

Returns

void

Defined in

index.ts:25

LockfileNodeFlagDev

const LockfileNodeFlagDev: 2 = 2

Defined in

lockfile/types.ts:36

LockfileNodeFlagDevOptional

const LockfileNodeFlagDevOptional: 3 = 3

Defined in

lockfile/types.ts:37

LockfileNodeFlagNone

const LockfileNodeFlagNone: 0 = 0

Defined in

lockfile/types.ts:34

LockfileNodeFlagOptional

const LockfileNodeFlagOptional: 1 = 1

Defined in

lockfile/types.ts:35

longDependencyTypes

const longDependencyTypes: Set<DependencyTypeLong>

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

Defined in

dependencies.ts:106

shortDependencyTypes

const shortDependencyTypes: Set<DependencyTypeShort>

A set of the short type keys used to represent dependency relationships.

Defined in

dependencies.ts:116

Functions

asDependency()

function asDependency(obj): Dependency

Parameters

• obj: unknown

Returns

Dependency

Defined in

dependencies.ts:95

asDependencyTypeShort()

function asDependencyTypeShort(obj): DependencyTypeShort

Parameters

• obj: unknown

Returns

DependencyTypeShort

Defined in

dependencies.ts:30

getBooleanFlagsFromNum()

function getBooleanFlagsFromNum(flags): object

Parameters

• flags: LockfileNodeFlags

Returns

object

dev
dev: boolean
optional
optional: boolean

Defined in

lockfile/types.ts:29

getFlagNumFromNode()

function getFlagNumFromNode(node): 0 | 1 | 2 | 3

Parameters

• node

• node.dev?: boolean

• node.optional?: boolean

Returns

0 | 1 | 2 | 3

Defined in

lockfile/types.ts:20

humanReadableOutput()

function humanReadableOutput(options): undefined | null | string

Returns a human-readable output of the graph.

Parameters

• options: HumanReadableOutputOptions

Returns

undefined | null | string

Defined in

visualization/human-readable-output.ts:99

isDependency()

function isDependency(o): o is Dependency

Parameters

• o: unknown

Returns

o is Dependency

Defined in

dependencies.ts:88

isDependencyTypeShort()

function isDependencyTypeShort(obj): obj is DependencyTypeShort

Parameters

• obj: unknown

Returns

obj is DependencyTypeShort

Defined in

dependencies.ts:25

jsonOutput()

function jsonOutput(__namedParameters): string

Returns a JSON string representation of the graph.

Parameters

• __namedParameters: JSONOutputOptions

Returns

string

Defined in

visualization/json-output.ts:39

mermaidOutput()

function mermaidOutput(__namedParameters): string

Returns a mermaid string representation of the graph.

Parameters

• __namedParameters: MermaidOutputOptions

Returns

string

Defined in

visualization/mermaid-output.ts:67

reify()

function reify(options): Promise<void>

Make the current project match the supplied graph.

Parameters

• options: ReifyOptions

Returns

Promise<void>

Defined in

reify/index.ts:45

shorten()

function shorten(typeLong, name?, manifest?): DependencyTypeShort

Get the DependencyTypeShort from a DependencyTypeLong.

Parameters

• typeLong: DependencyTypeLong

• name?: string

• manifest?: Manifest

Returns

DependencyTypeShort

Defined in

dependencies.ts:141

stringifyNode()

function stringifyNode(node?): string

Parameters

• node?: NodeLike

Returns

string

Defined in

stringify-node.ts:4