fix: adjust terminology (#97)

Author: luckasnix

docs/object-graph.doc.md

@@ -18,39 +18,39 @@ Returns an instance of ObjectGraph.
 
 ### length
 
-Returns the length of the object graph.
+Returns the length of the graph.
 
 ### size
 
-Returns the size of the object graph.
+Returns the size of the graph.
 
 ## Instance Methods
 
 ### keys()
 
-Returns an iterator object that contains the keys of the object graph.
+Returns an iterator that contains the keys of the graph.
 
 ### values()
 
-Returns an iterator object that contains the values of the object graph.
+Returns an iterator that contains the values of the graph.
 
 ### get()
 
-Returns a node of the object graph.
+Returns a node of the graph.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeKey | `string` | - | __Required.__ The key of the node to return from the object graph. |
+| nodeKey | `string` | - | __Required.__ The key of the node to return from the graph. |
 
 ### copy()
 
-Returns a copy of the original object graph.
+Returns a copy of the original graph.
 
 ### subgraph()
 
-Returns a subgraph of the original object graph.
+Returns a subgraph of the original graph.
 
 #### Parameters
 
@@ -60,73 +60,73 @@ Returns a subgraph of the original object graph.
 
 ### add()
 
-Adds a node to the object graph.
+Adds a node to the graph.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeValue | `NodeValue` | - | __Required.__ The value of the node to add to the object graph. |
+| nodeValue | `NodeValue` | - | __Required.__ The value of the node to add to the graph. |
 
 ### toAdded()
 
-Returns a copy of the original object graph with a received node added.
+Returns a copy of the original graph with a received node added.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeValue | `NodeValue` | - | __Required.__ The value of the node to add to the object graph. |
+| nodeValue | `NodeValue` | - | __Required.__ The value of the node to add to the graph. |
 
 ### update()
 
-Updates a node in the object graph.
+Updates a node in the graph.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeValue | `NodeValue` | - | __Required.__ The value of the node to update in the object graph. |
+| nodeValue | `NodeValue` | - | __Required.__ The value of the node to update in the graph. |
 
 ### toUpdated()
 
-Returns a copy of the original object graph with a received node updated.
+Returns a copy of the original graph with a received node updated.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeValue | `NodeValue` | - | __Required.__ The value of the node to update in the object graph. |
+| nodeValue | `NodeValue` | - | __Required.__ The value of the node to update in the graph. |
 
 ### remove()
 
-Removes a node from the object graph.
+Removes a node from the graph.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeKey | `string` | - | __Required.__ The key of the node to remove from the object graph. |
+| nodeKey | `string` | - | __Required.__ The key of the node to remove from the graph. |
 
 ### toRemoved()
 
-Returns a copy of the original object graph with a received node removed.
+Returns a copy of the original graph with a received node removed.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| nodeKey | `string` | - | __Required.__ The key of the node to remove from the object graph. |
+| nodeKey | `string` | - | __Required.__ The key of the node to remove from the graph. |
 
 ### valuesOf()
 
-Returns a list of unique values for a specified property across selected nodes in the object graph. If no selection is made, it operates on the entire graph.
+Returns a list of unique values for a specified property across selected nodes in the graph. If no selection is made, it operates on the entire graph.
 
 #### Parameters
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| propertyKey | `keyof NodeValue` | - | __Required.__ The property key of the node values to return from the object graph. |
+| propertyKey | `keyof NodeValue` | - | __Required.__ The property key of the node values to return from the graph. |
 | nodeKeys | `Array<string>` | - | The array of nodes keys to define the selected nodes. |
 
 ### valuesBy()
@@ -141,4 +141,4 @@ Returns all nodes that match with the provided shape.
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| shape | `Partial<Record<keyof NodeValue, unknown>>` | - | __Required.__ The shape of the nodes to return from the object graph. |
+| shape | `Partial<Record<keyof NodeValue, unknown>>` | - | __Required.__ The shape of the nodes to return from the graph. |

package-lock.json

@@ -2,7 +2,7 @@
   "name": "@kasnix/structured-objects",
   "description": "A lightweight and powerful library for manipulating objects in JavaScript and TypeScript across different types of data structures.",
   "author": "Kasnix",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/luckasnix/structured-objects.git"

package.json

@@ -26,7 +26,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Returns the length of the object graph.
+   * @description Returns the length of the graph.
    * @since 1.0.0
    * @deprecated Since version 1.2.0. Will be removed in version 2.0.0. Use "size" instead.
    */
@@ -35,31 +35,31 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Returns the size of the object graph.
+   * @description Returns the size of the graph.
    * @since 1.2.0
    */
   public get size(): number {
     return this.nodes.size;
   }
 
   /**
-   * @description Returns an iterator object that contains the keys of the object graph.
+   * @description Returns an iterator that contains the keys of the graph.
    * @since 1.0.0
    */
   public keys(): IterableIterator<string> {
     return this.nodes.keys();
   }
 
   /**
-   * @description Returns an iterator object that contains the values of the object graph.
+   * @description Returns an iterator that contains the values of the graph.
    * @since 1.0.0
    */
   public values(): IterableIterator<NodeValue> {
     return this.nodes.values();
   }
 
   /**
-   * @description Returns a node of the object graph.
+   * @description Returns a node of the graph.
    * @since 1.0.0
    */
   public get(nodeKey: string): NodeValue | undefined {
@@ -71,21 +71,21 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
     }
     const nodeValue = this.nodes.get(nodeKey);
     if (!nodeValue) {
-      console.error("A node with this key does not exist in the object graph");
+      console.error("A node with this key does not exist in the graph");
     }
     return nodeValue;
   }
 
   /**
-   * @description Returns a copy of the original object graph.
+   * @description Returns a copy of the original graph.
    * @since 1.0.0
    */
   public copy(): ObjectGraph<NodeValue> {
     return new ObjectGraph(Array.from(this.nodes.values()), this.keyExtractor);
   }
 
   /**
-   * @description Returns a subgraph of the original object graph.
+   * @description Returns a subgraph of the original graph.
    * @since 1.3.0
    */
   public subgraph(nodeKeys: Array<string>): ObjectGraph<NodeValue> {
@@ -110,7 +110,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Adds a node to the object graph.
+   * @description Adds a node to the graph.
    * @since 1.0.0
    */
   public add(nodeValue: NodeValue): void {
@@ -119,15 +119,13 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
     }
     const nodeKey = this.keyExtractor(nodeValue);
     if (this.nodes.get(nodeKey)) {
-      throw new Error(
-        "A node with the same key already exists in the object graph",
-      );
+      throw new Error("A node with the same key already exists in the graph");
     }
     this.nodes.set(nodeKey, nodeValue);
   }
 
   /**
-   * @description Returns a copy of the original object graph with a received node added.
+   * @description Returns a copy of the original graph with a received node added.
    * @since 1.0.0
    */
   public toAdded(nodeValue: NodeValue): ObjectGraph<NodeValue> {
@@ -137,7 +135,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Updates a node in the object graph.
+   * @description Updates a node in the graph.
    * @since 1.0.0
    */
   public update(nodeValue: NodeValue): void {
@@ -147,14 +145,14 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
     const nodeKey = this.keyExtractor(nodeValue);
     if (!this.nodes.get(nodeKey)) {
       throw new Error(
-        "A node with the provided key does not exist in the object graph",
+        "A node with the provided key does not exist in the graph",
       );
     }
     this.nodes.set(nodeKey, nodeValue);
   }
 
   /**
-   * @description Returns a copy of the original object graph with a received node updated.
+   * @description Returns a copy of the original graph with a received node updated.
    * @since 1.0.0
    */
   public toUpdated(nodeValue: NodeValue): ObjectGraph<NodeValue> {
@@ -164,7 +162,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Removes a node from the object graph.
+   * @description Removes a node from the graph.
    * @since 1.0.0
    */
   public remove(nodeKey: string): void {
@@ -178,7 +176,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Returns a copy of the original object graph with a received node removed.
+   * @description Returns a copy of the original graph with a received node removed.
    * @since 1.0.0
    */
   public toRemoved(nodeKey: string): ObjectGraph<NodeValue> {
@@ -188,7 +186,7 @@ export class ObjectGraph<NodeValue extends Record<string, unknown>> {
   }
 
   /**
-   * @description Returns a list of unique values for a specified property across selected nodes in the object graph. If no selection is made, it operates on the entire graph.
+   * @description Returns a list of unique values for a specified property across selected nodes in the graph. If no selection is made, it operates on the entire graph.
    * @since 1.0.0
    */
   public valuesOf<NodeValueKey extends keyof NodeValue>(