docs: add a description to the constructor (#20)

luckasnix · Jul 2, 2024 · 2717b2a · 2717b2a
1 parent d3b934d
commit 2717b2a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/object-graph.md b/docs/object-graph.md
@@ -3,7 +3,7 @@
 
 ## Constructor
 
-Instantiates an object graph.
+Returns an instance of ObjectGraph.
 
 ### Parameters
 

diff --git a/src/object-graph/index.ts b/src/object-graph/index.ts
@@ -2,6 +2,9 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   private nodes: Map<string, NodeValue>;
   private keyExtractor: (nodeValue: NodeValue) => string;
 
+  /**
+   * @description Returns an instance of ObjectGraph.
+   */
   constructor(nodeValues: Array<NodeValue>, keyExtractor: (nodeValue: NodeValue) => string) {
     if (!nodeValues) {
       throw new Error("Provide a value for the 'nodeValues' parameter");