Configuration

Overview

Configuration reference for Nest Graph Inspector.

Nest Graph Inspector is configured through the forRoot or forRootAsync static methods on the NestGraphInspectorModule.

Example

root.module.ts

import { Module } from '@nestjs/common';
import { NestGraphInspectorModule } from 'nest-graph-inspector';

@Module({
  imports: [
    NestGraphInspectorModule.forRoot({
      outputs: [
        { type: 'viewer' }
      ]
    }),
  ],
})
export class RootModule {}

Topics

Outputs — where the graph is published
Root module — which module graph traversal starts from
Access token — the gate in front of every inspector endpoint
UI — how the viewer's saved layout is persisted

Upgrade Guide

Upgrade Nest Graph Inspector when the viewer asks for a newer graph output version, and what to change when a release breaks something.

Outputs

Choose where Nest Graph Inspector publishes your dependency graph.