Docs

Author: niclasko

.gitignore

@@ -422,4 +422,7 @@ dist/
 node_modules/
 .vscode/
 .env
-coaching_prototype.cql
+coaching_prototype.cql
+
+# TypeDoc API documentation (generated)
+docs/api/

package-lock.json

@@ -7,7 +7,8 @@
     "start": "ts-node src/index.ts",
     "test": "jest",
     "build": "webpack && copy dist\\flowquery.min.js web\\flowquery.min.js && copy dist\\flowquery.min.js docs\\flowquery.min.js && copy web\\index.html docs\\index.html",
-    "main": "tsc & node dist/index.js"
+    "main": "tsc & node dist/index.js",
+    "docs": "typedoc --out docs/api src/index.ts"
   },
   "keywords": [],
   "author": "",
@@ -17,6 +18,7 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
     "ts-loader": "^9.5.1",
+    "typedoc": "^0.28.14",
     "typescript": "^5.7.2",
     "webpack": "^5.97.1",
     "webpack-cli": "^6.0.1"

package.json

@@ -1,9 +1,29 @@
 import Operation from "../parsing/operations/operation";
 import Parser from "../parsing/parser";
 
+/**
+ * Executes a FlowQuery statement and retrieves the results.
+ * 
+ * The Runner class parses a FlowQuery statement into an AST and executes it,
+ * managing the execution flow from the first operation to the final return statement.
+ * 
+ * @example
+ * ```typescript
+ * const runner = new Runner("WITH x = 1 RETURN x");
+ * await runner.run();
+ * console.log(runner.results); // [{ x: 1 }]
+ * ```
+ */
 class Runner {
     private first: Operation;
     private last: Operation;
+    
+    /**
+     * Creates a new Runner instance and parses the FlowQuery statement.
+     * 
+     * @param statement - The FlowQuery statement to execute
+     * @throws {Error} If the statement is null, empty, or contains syntax errors
+     */
     constructor(statement: string | null = null) {
         if(statement === null || statement === "") {
             throw new Error("Statement cannot be null or empty");
@@ -13,6 +33,13 @@ class Runner {
         this.first = ast.firstChild() as Operation;
         this.last = ast.lastChild() as Operation;
     }
+    
+    /**
+     * Executes the parsed FlowQuery statement.
+     * 
+     * @returns A promise that resolves when execution completes
+     * @throws {Error} If an error occurs during execution
+     */
     public async run(): Promise<void> {
         return new Promise<void>(async (resolve, reject) => {
             try {
@@ -24,6 +51,12 @@ class Runner {
             }
         });
     }
+    
+    /**
+     * Gets the results from the executed statement.
+     * 
+     * @returns The results from the last operation (typically a RETURN statement)
+     */
     public get results(): any {
         return this.last.results;
     }