🎉 NEW: add 'order', 'limit' and 'having'

Author: casperiv0

.eslintrc.json

@@ -16,7 +16,7 @@
     "semi": ["error", "always"],
     "no-multi-spaces": ["error"],
     "eqeqeq": ["warn", "always"],
-    "no-unused-vars": ["error"],
+    "no-unused-vars": "off",
     "no-duplicate-case": ["error"],
     "no-extra-semi": ["error"],
     "no-unreachable": ["error"],

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 dist
+.env

README.md

@@ -1,5 +1,36 @@
-# node-mysql
+# mysql.ts
 
 A simple node.js MySQL wrapper made with TypeScript.
 
 **This package is still in development!**
+
+## Installation
+
+### npm
+
+```bash
+npm i mysql.ts
+```
+
+### Yarn
+
+```bash
+yarn add mysql.ts
+```
+
+## Usage
+
+```ts
+import { createConnection } from "mysql.ts";
+
+async function init() {
+  const connection = await createConnection({
+    /* options */
+  });
+
+  // query something
+  const results = await connection.query.select(["id", "name"]).from("books").exec();
+
+  console.log(results);
+}
+```

docs/README.md

@@ -0,0 +1,32 @@
+# Documentation
+
+## Installation
+
+### npm
+
+```bash
+npm i mysql.ts
+```
+
+### Yarn
+
+```bash
+yarn add mysql.ts
+```
+
+## Usage
+
+```ts
+import { createConnection } from "mysql.ts";
+
+async function init() {
+  const connection = await createConnection({
+    /* options */
+  });
+
+  // query something
+  const results = await connection.query.select(["id", "name"]).from("books").exec();
+
+  console.log(results);
+}
+```

docs/connection.md

@@ -0,0 +1 @@
+# Connection

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@casper124578/node-mysql",
+  "name": "mysql.ts",
   "version": "0.0.0-alpha",
   "description": "A simple mysql wrapper for node.js",
   "main": "dist/index.js",
@@ -10,7 +10,8 @@
   "keywords": [
     "mysql",
     "mysql-wrapper",
-    "easy-mysql"
+    "easy-mysql",
+    "mysql typescript"
   ],
   "author": {
     "name": "Dev-CasperTheGhost",

src/Connection.ts

@@ -13,9 +13,9 @@ export class Connection {
     this.config = config;
 
     if (typeof config !== "string") {
-      this.reconnect = config.reconnect ?? false;
+      this.reconnect = config.reconnect ?? true;
     } else {
-      this.reconnect = false;
+      this.reconnect = true;
     }
 
     // @ts-expect-error ignore
@@ -37,6 +37,38 @@ export class Connection {
       });
   }
 
+  destroy() {
+    this.connection.destroy();
+  }
+
+  end() {
+    return new Promise((resolve, reject) => {
+      return this.connection.end((err) => {
+        if (err) {
+          return reject(err);
+        }
+
+        resolve(true);
+      });
+    });
+  }
+
+  format(sql: string, values: unknown[]) {
+    return this.connection.format(sql, values);
+  }
+
+  pause() {
+    this.connection.pause();
+  }
+
+  resume() {
+    this.connection.resume();
+  }
+
+  on(eventName: string, listener: (...args: any[]) => void) {
+    this.connection.on(eventName, listener);
+  }
+
   async connect(): Promise<mysql.Connection> {
     const connection = mysql.createConnection(this.config);
 

src/QueryBuilder.ts

@@ -11,8 +11,23 @@ export class QueryBuilder {
     this.values = [];
   }
 
-  select(selector: string) {
-    this.query += `SELECT ${selector} `;
+  /**
+   * Select 1 or more items from a table
+   * @param {string|string[]} selector
+   * @example
+   *
+   * // 1 item
+   * <Connection>.query.select("id").from("books");
+   *
+   * // multiple items
+   * <Connection>.query.select(["id", "name"]).from("books");
+   */
+  select(selector: string | string[]) {
+    if (typeof selector === "string") {
+      this.query += `SELECT ${selector} `;
+    } else {
+      this.query += `SELECT ${selector.join(", ")} `;
+    }
 
     return this;
   }
@@ -83,6 +98,24 @@ export class QueryBuilder {
     return this;
   }
 
+  order(selector: string, type: "ASC" | "DESC") {
+    this.query += `ORDER BY ${selector} ${type.toUpperCase()} `;
+
+    return this;
+  }
+
+  limit(n: number | string) {
+    this.query += `LIMIT ${n}`;
+
+    return this;
+  }
+
+  having(condition: string) {
+    this.query += `HAVING ${condition} `;
+
+    return this;
+  }
+
   raw(query: string, values: unknown[]) {
     this.query = query;
     this.values = values;
@@ -94,9 +127,6 @@ export class QueryBuilder {
    * Execute the query
    */
   async exec<T>(): Promise<T[]> {
-    console.log(this.values);
-    console.log(this.query);
-
     return new Promise((resolve, reject) => {
       this.connection.query(this.query, this.values, (err, results) => {
         if (err) {

tests/index.test.ts

@@ -1,19 +1,25 @@
-import { createConnection } from "../dist/index";
+import { createConnection } from "../src/index";
 
 async function test() {
   const conn = await createConnection({
     host: "192.168.0.140",
     user: "root",
     password: "",
     database: "snaily-cad",
+    reconnect: true,
   });
 
-  // const sql = conn.query.select("id").from("citizens").where("id", "b33a9b77-3313-43df-a2c2-1e6e20858b81");
+  const sql = conn.query.select("*").from("citizens").order("full_name", "ASC");
 
-  const sql = conn.query.delete("citizens").where("id", "b33a9b77-3313-43df-a2c2-1e6e20858b81");
-  const result = await sql.exec<{ id: string }>().catch(console.error);
+  // const sql = conn.query.delete("citizens").where("id", "b33a9b77-3313-43df-a2c2-1e6e20858b81");
+  const result = await sql.exec().catch(console.error);
+
+  console.log(conn.query.values);
+  console.log(conn.query.query);
 
   console.log(result);
+
+  await conn.end();
 }
 
 test();