🎉 NEW: 0.0.17

Author: casperiv0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.0.17
+
+- Add `returnEmptyArrayForNoResults` to `ConnectionConfig`
+- Minor code improvements
+
 ## 0.0.16
 
 - add `QueryBuilder#resetQuery` method

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casper124578/mysql.ts",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "A simple mysql wrapper for node.js",
   "main": "dist/index.js",
   "private": false,

src/Connection.ts

@@ -7,17 +7,14 @@ export class Connection<Tables> {
   public config: ConnectionConfig | string;
   public connection!: mysql.Connection;
   private reconnect: boolean;
-  private debug: boolean;
 
   constructor(config: ConnectionConfig | string = {}) {
     let _connection: mysql.Connection;
     this.config = config;
 
     if (typeof config !== "string") {
       this.reconnect = config.reconnect ?? true;
-      this.debug = config.debugExec ?? false;
     } else {
-      this.debug = false;
       this.reconnect = true;
     }
 
@@ -78,7 +75,7 @@ export class Connection<Tables> {
   }
 
   query<T = any>(): QueryBuilder<Tables, T> {
-    return new QueryBuilder<Tables, T>(this.connection, this.debug);
+    return new QueryBuilder<Tables, T>(this.connection, this.config);
   }
 
   resume(): void {

src/QueryBuilder.ts

@@ -1,17 +1,17 @@
 import mysql from "mysql";
-import { QueryValue } from "./types";
+import { ConnectionConfig, QueryValue } from "./types";
 
 export class QueryBuilder<Tables, T = any> {
   private connection: mysql.Connection;
-  private debug!: boolean;
+  private config!: ConnectionConfig;
   query: string;
   values: unknown[];
 
-  constructor(connection: mysql.Connection, debug?: boolean) {
+  constructor(connection: mysql.Connection, config?: string | ConnectionConfig) {
     this.connection = connection;
 
-    if (debug) {
-      this.debug = debug;
+    if (config && typeof config === "object") {
+      this.config = config;
     }
 
     this.query = "";
@@ -58,7 +58,7 @@ export class QueryBuilder<Tables, T = any> {
     });
 
     this.query += `INSERT INTO ${tableName} (${this.createKeys(data)}) VALUES (${this.createValues(data)}) `;
-    this.values = [...this.values, ...values];
+    this.values.push(...values);
 
     return this;
   }
@@ -78,7 +78,7 @@ export class QueryBuilder<Tables, T = any> {
     });
 
     this.query += `UPDATE ${tableName} SET ${keys} `;
-    this.values = [...this.values, ...values];
+    this.values.push(...values);
 
     return this;
   }
@@ -272,8 +272,8 @@ export class QueryBuilder<Tables, T = any> {
   /**
    * Execute the query
    */
-  async exec(options?: Omit<mysql.QueryOptions, "sql" | "values">): Promise<T[]> {
-    if (this.debug === true) {
+  async exec(options?: Omit<mysql.QueryOptions, "sql" | "values">): Promise<T[] | undefined> {
+    if (this.config.debugExec === true) {
       console.info(`[mysql.ts]: Query: ${this.query}`);
       console.info("[mysql.ts]: Values: ", this.values);
     }
@@ -286,14 +286,19 @@ export class QueryBuilder<Tables, T = any> {
       const opts = options ? { ...options, sql: this.query, values: this.values } : this.query;
 
       this.connection.query(opts, this.values, (err, results) => {
-        this.query = "";
-        this.values = [];
+        this.resetQuery();
 
         if (err) {
           return reject(err);
         }
 
-        return resolve(results);
+        if (this.config.returnEmptyArrayForNoResults) {
+          return resolve(results);
+        } else {
+          if (results.length <= 0) {
+            return resolve(undefined);
+          }
+        }
       });
     });
   }

src/types.ts

@@ -7,6 +7,17 @@ export interface ConnectionConfig extends MySQLConnectionConfig {
    * This will show the full query & values when a query is executed with the `QueryBuilder#exec` method
    */
   debugExec?: boolean;
+
+  /**
+   * When no results are found for a query:
+   *
+   * `false` = return `undefined`
+   *
+   * `true` = returns an empty array
+   *
+   * @default false
+   */
+  returnEmptyArrayForNoResults?: boolean;
 }
 
 export interface StatisticsPacket {

tests/index.test.ts

@@ -17,11 +17,12 @@ async function test() {
     database: "snaily-cad",
     reconnect: true,
     debugExec: true,
+    returnEmptyArrayForNoResults: false,
   });
 
-  const x = conn.query().select("*").from("citizens").where("x", 3);
+  const x = await conn.query().select("*").from("citizens").where("id", "qsd").exec();
 
-  console.log(x);
+  console.log(x?.[0].id);
 
   // const d = await conn.query().drop("books", "database").exec();