Class GraphReporter

Index

Constructors

Methods

createSnapshot toDOT toMermaid toD2 toCSV toJSON toHTML exportAsDOT exportAsMermaid exportAsD2 exportAsCSV exportAsJSON exportAsHTML

Constructors

constructor

new GraphReporter(): GraphReporter
Returns GraphReporter

Methods

`Static`createSnapshot

createSnapshot(graph: Edge[], options?: GraphQueryOptions): GraphReportSnapshot
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns GraphReportSnapshot
- Defined in graph/graph-reporter.ts:196

`Static`toDOT

toDOT(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:266

`Static`toMermaid

toMermaid(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:285

`Static`toD2

toD2(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:307

`Static`toCSV

toCSV(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:323

`Static`toJSON

toJSON(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:340

`Static`toHTML

toHTML(graph: Edge[], options?: GraphQueryOptions): string
Parameters
- graph: Edge[]
- options: GraphQueryOptions = {}
Returns string
- Defined in graph/graph-reporter.ts:344

`Static`exportAsDOT

exportAsDOT(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:417

`Static`exportAsMermaid

exportAsMermaid(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:425

`Static`exportAsD2

exportAsD2(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:433

`Static`exportAsCSV

exportAsCSV(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:441

`Static`exportAsJSON

exportAsJSON(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:449

`Static`exportAsHTML

exportAsHTML(
    graph: Edge[],
    outputPath: string,
    options?: GraphQueryOptions,
): Promise<void>
Parameters
- graph: Edge[]
- outputPath: string
- options: GraphQueryOptions = {}
Returns Promise<void>
- Defined in graph/graph-reporter.ts:457