Class ProjectGraphBuilder

constructor

• new ProjectGraphBuilder(
      tsConfigFilePath?: string,
      options?: GraphQueryOptions,
      checkOptions?: CheckOptions,
  ): ProjectGraphBuilder

  Parameters

  • OptionaltsConfigFilePath: string
  • options: GraphQueryOptions = {}
  • OptionalcheckOptions: CheckOptions

  Returns ProjectGraphBuilder

Optional ReadonlytsConfigFilePath

includeExternalDependencies

• includeExternalDependencies(): ProjectGraphBuilder

  Returns ProjectGraphBuilder

includeSelfDependencies

• includeSelfDependencies(): ProjectGraphBuilder

  Returns ProjectGraphBuilder

focusOn

• focusOn(pattern: Pattern, depth?: number): ProjectGraphBuilder

  Parameters

  • pattern: Pattern
  • depth: number = 1

  Returns ProjectGraphBuilder

reachableFrom

• reachableFrom(pattern: Pattern): ProjectGraphBuilder

  Parameters

  • pattern: Pattern

  Returns ProjectGraphBuilder

dependentsOf

• dependentsOf(pattern: Pattern): ProjectGraphBuilder

  Parameters

  • pattern: Pattern

  Returns ProjectGraphBuilder

collapseToFolderDepth

• collapseToFolderDepth(depth: number): ProjectGraphBuilder

  Parameters

  • depth: number

  Returns ProjectGraphBuilder

collapseByPattern

• collapseByPattern(pattern: RegExp, replacement?: string): ProjectGraphBuilder

  Parameters

  • pattern: RegExp
  • replacement: string = '$1'

  Returns ProjectGraphBuilder

titled

• titled(title: string): ProjectGraphBuilder

  Parameters

  • title: string

  Returns ProjectGraphBuilder

withCheckOptions

• withCheckOptions(checkOptions: CheckOptions): ProjectGraphBuilder

  Parameters

  • checkOptions: CheckOptions

  Returns ProjectGraphBuilder

snapshot

• snapshot(): Promise<GraphReportSnapshot>

  Returns Promise<GraphReportSnapshot>

toDOT

• toDOT(): Promise<string>

  Returns Promise<string>

toMermaid

• toMermaid(): Promise<string>

  Returns Promise<string>

toD2

• toD2(): Promise<string>

  Returns Promise<string>

toCSV

• toCSV(): Promise<string>

  Returns Promise<string>

toJSON

• toJSON(): Promise<string>

  Returns Promise<string>

toHTML

• toHTML(): Promise<string>

  Returns Promise<string>

exportAsDOT

• exportAsDOT(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>

exportAsMermaid

• exportAsMermaid(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>

exportAsD2

• exportAsD2(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>

exportAsCSV

• exportAsCSV(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>

exportAsJSON

• exportAsJSON(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>

exportAsHTML

• exportAsHTML(outputPath: string): Promise<void>

  Parameters

  • outputPath: string

  Returns Promise<void>