Interface DependencyModel

The versioned, JSON-serializable root of the Dependency Model -- see this module's own doc comment for the full picture.

interface DependencyModel {
    consumers: readonly DependencyModelConsumer[];
    contracts: readonly DependencyModelContract[];
    scannedSurfaces: readonly ScannedSurface[];
    schemaVersion: 2;
    warnings: readonly ParseWarning[];
}

Index

Properties

consumers contracts scannedSurfaces schemaVersion warnings

Properties

`Readonly`consumers

consumers: readonly DependencyModelConsumer[]

Inverse of contracts[].consumingFiles -- one entry per file that consumes at least one contract, listing which contracts it reads.

`Readonly`contracts

contracts: readonly DependencyModelContract[]

`Readonly`scannedSurfaces

scannedSurfaces: readonly ScannedSurface[]

Every surface actually scanned for usage -- see ADR 0036. Always has at least one entry (the application root).

`Readonly`schemaVersion

schemaVersion: 2

`Readonly`warnings

warnings: readonly ParseWarning[]