fix(core): add js docs to graph json

nrwl · Aug 23, 2024 · aee664f · aee664f
1 parent a4f48e2
commit aee664f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/generated/devkit/GraphJson.md b/docs/generated/devkit/GraphJson.md
@@ -1,5 +1,7 @@
 # Interface: GraphJson
 
+The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains
+
 ## Table of contents
 
 ### Properties
@@ -14,14 +16,20 @@
 
 • **graph**: [`ProjectGraph`](../../devkit/documents/ProjectGraph)
 
+The project graph
+
 ---
 
 ### taskPlans
 
 • `Optional` **taskPlans**: `Record`\<`string`, `string`[]\>
 
+The plans for hashing a task in the task graph
+
 ---
 
 ### tasks
 
 • `Optional` **tasks**: [`TaskGraph`](../../devkit/documents/TaskGraph)
+
+A graph of tasks populated with `nx build --graph`
diff --git a/packages/nx/src/command-line/graph/graph.ts b/packages/nx/src/command-line/graph/graph.ts
@@ -1155,9 +1155,21 @@ function expandInputs(
   };
 }
 
+/**
+ * The data type that `nx graph --file graph.json` or `nx build --graph graph.json` contains
+ */
 export interface GraphJson {
+  /**
+   * A graph of tasks populated with `nx build --graph`
+   */
   tasks?: TaskGraph;
+  /**
+   * The plans for hashing a task in the task graph
+   */
   taskPlans?: Record<string, string[]>;
+  /**
+   * The project graph
+   */
   graph: ProjectGraph;
 }