Merge pull request #24 from datastructures-js/add_fn

getVertexValue

CHANGELOG.md

@@ -5,10 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [v5.3.0] - 2022-11-07
+### Added
+- `getVertexValue(key)` returns vertex value.
+
 ## [v5.2.0] - 2022-11-07
 ### Added
-- `.getConnectedVertices(key)` to get connected nodes to a given node.
-- `.getConnecetedEdges(key)`to get connected edges from a given node.
+- `getConnectedVertices(key)` to get connected nodes to a given node.
+- `getConnecetedEdges(key)`to get connected edges from a given node.
 - `traverseDfs(key, cb, abortCb)` added abortCb optional param to abort traversal.
 - `traverseBfs(key, cb, abortCb)` added abortCb optional param to abort traversal.
 

README.md

@@ -15,6 +15,7 @@ Graph & Directed Graph implementation in javascript.
   * [constructor](#constructor)
   * [addVertex](#addvertex)
   * [hasVertex](#hasvertex)
+  * [getVertexValue](#getvertexvalue)
   * [getVerticesCount](#getverticescount)
   * [addEdge](#addedge)
   * [hasEdge](#hasedge)
@@ -96,6 +97,14 @@ console.log(directedGraph.hasVertex('v7')); // false
 console.log(graph.hasVertex('v1')); // true
 ```
 
+### getVertexValue
+Returns the value associated with a vertex key.
+
+```js
+console.log(directedGraph.getVertexValue('v5')); // 5
+console.log(graph.getVertexValue('v1')); // true
+```
+
 ### getVerticesCount
 Gets the number of vertices in the graph.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datastructures-js/graph",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "graph & directed graph implementation in javascript",
   "main": "index.js",
   "types": "index.d.ts",

src/directedGraph.d.ts

@@ -1,6 +1,7 @@
 export class DirectedGraph<T extends number|string, U = undefined> {
   addVertex(key: T, value: U): DirectedGraph<T, U>;
   hasVertex(key: T): boolean;
+  getVertexValue(key: T): U;
   removeVertex(key: T): boolean;
   getVerticesCount(): number;
   getConnectedVertices(key: T): T[];

src/directedGraph.js

@@ -41,6 +41,16 @@ class DirectedGraph {
     return this._vertices.has(key);
   }
 
+  /**
+   * returns vertex value
+   * @public
+   * @param {number|string} key
+   * @return {object}
+   */
+  getVertexValue(key) {
+    return this._vertices.get(key);
+  }
+
   /**
    * Removes a vertex and all its edges from the graph
    * @public