Converted to typescript

Author: Robert Kesterson

.circleci/config.yml

@@ -45,6 +45,7 @@ jobs:
 
       # run tests!
       - run: sudo npm install -g istanbul codecov
+      - run: npx tsc
       - run: istanbul cover ./node_modules/mocha/bin/_mocha -- -R spec --exit 
       - early_return_for_forked_pull_requests
       - run: codecov -t ${CODECOV_TOKEN}

.gitignore

@@ -7,3 +7,4 @@ yarn.lock
 examples/node_modules
 coverage/
 .DS_Store
+dist/

examples/redisGraphExample.js renamed to examples/redisGraphExample.ts

@@ -1,4 +1,5 @@
-const RedisGraph = require("redisgraph.js").Graph;
+
+import {Graph as RedisGraph} from 'redisgraph.js';
 
 let graph = new RedisGraph("social");
 
@@ -18,7 +19,7 @@ try {
 			let record = res.next();
 			console.log(record.get("a.name"));
 		}
-		console.log(res.getStatistics().queryExecutionTime());
+		console.log(res.getStatistics()?.queryExecutionTime());
 
 		// Match with parameters.
 		let param = { age: 30 };

examples/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "target": "es5",
+        "module": "UMD",
+        "lib": ["es5"],
+        "strict": true,
+        "allowJs": true,
+        "inlineSourceMap": true,
+        "inlineSources": true,
+        "outDir": "./dist",
+        "moduleResolution": "node",
+        "downlevelIteration": true,
+        "rootDir": "./",
+        "baseUrl": "./",
+        "declaration": true,
+       
+    },
+    "include": ["./"],
+    "exclude": ["dist"]
+}

index.js

@@ -13,10 +13,13 @@
 		"redis": "^3.0.2"
 	},
 	"devDependencies": {
-		"mocha": "^7.0.1"
+		"@types/deep-equal": "^1.0.1",
+		"@types/redis": "^2.8.28",
+		"mocha": "^7.0.1",
+		"typescript": "^4.1.3"
 	},
 	"scripts": {
-		"test": "mocha --exit"
+		"test": "npx tsc && mocha --exit"
 	},
-	"main": "index.js"
+	"main": "dist/index.js"
 }

package.json

@@ -1,8 +1,10 @@
-"use strict";
+import {Node} from "./node";
 /**
  * An edge connecting two nodes.
  */
-class Edge {
+export class Edge {
+
+     private id?: number;
     /**
      * Builds an Edge object.
      * @constructor
@@ -11,7 +13,7 @@ class Edge {
      * @param {Node} destNode - Destination node of the edge.
      * @param {Map} properties - Properties map of the edge.
      */
-	constructor(srcNode, relation, destNode, properties) {
+	constructor(private srcNode: Node, private relation: string, private destNode: Node, private properties: Map<string, any>) {
 		this.id = undefined;            //edge's id - set by RedisGraph
 		this.relation = relation;       //edge's relationship type
 		this.srcNode = srcNode;         //edge's source node
@@ -23,7 +25,7 @@ class Edge {
      * Sets the edge ID.
      * @param {int} id 
      */
-	setId(id) {
+	setId(id:number) {
 		this.id = id;
     }
 
@@ -35,4 +37,3 @@ class Edge {
 	}
 }
 
-module.exports = Edge;