docs: adjust the documentation of the "keys" and "values" methods (#42)

luckasnix · Sep 14, 2024 · e332995 · e332995
1 parent a7fffad
commit e332995
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/object-graph.doc.md b/docs/object-graph.doc.md
@@ -18,11 +18,11 @@ Returns the length of the object graph.
 
 ## keys()
 
-Returns the keys of the object graph.
+Returns an iterator object that contains the keys of the object graph.
 
 ## values()
 
-Returns the values of the object graph.
+Returns an iterator object that contains the values of the object graph.
 
 ## get()
 

diff --git a/src/object-graph.ts b/src/object-graph.ts
@@ -31,15 +31,15 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Returns the keys of the object graph.
+   * @description Returns an iterator object that contains the keys of the object graph.
    * @since 0.1.0
    */
   public keys() {
     return this.nodes.keys();
   }
 
   /**
-   * @description Returns the values of the object graph.
+   * @description Returns an iterator object that contains the values of the object graph.
    * @since 0.1.0
    */
   public values() {