🎉 NEW: 0.1.0

Author: casperiv0

.eslintrc.json

@@ -4,23 +4,13 @@
     "es2021": true,
     "node": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended",
-    "prettier",
-    "@casper124578/eslint-config",
-    "plugin:prettier/recommended"
-  ],
+  "extends": ["@casper124578/eslint-config"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "prettier"],
   "rules": {
-    "prettier/prettier": ["error"],
-    "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off",
     "prefer-rest-params": "off"
   }
 }

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.1.0
+
+- **BREAKING:** Remove `returnEmptyArrayForNoResults`
+- Bump dependencies
+- Format code
+
 ## 0.0.20
 
 - Make [`BuilderTypes`](https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/BuilderTypes.md) options optional

docs/Query.md

@@ -118,7 +118,12 @@ const connection = await createConnection({
   /* ... */
 });
 
-const result = await connection.query().select("*").from("books").whereLike("name", "%cool%").exec();
+const result = await connection
+  .query()
+  .select("*")
+  .from("books")
+  .whereLike("name", "%cool%")
+  .exec();
 ```
 
 [Back to top](#methods)
@@ -130,7 +135,13 @@ const connection = await createConnection({
   /* ... */
 });
 
-const result = await connection.query().select("*").from("books").where("id", "0").and("name", "my-cool-name").exec();
+const result = await connection
+  .query()
+  .select("*")
+  .from("books")
+  .where("id", "0")
+  .and("name", "my-cool-name")
+  .exec();
 ```
 
 [Back to top](#methods)
@@ -198,7 +209,11 @@ const result = await connection
   .exec();
 
 // With chaining
-const result = await connection.query().raw("SELECT * FROM `books`").where("name", "cool-book-name").exec();
+const result = await connection
+  .query()
+  .raw("SELECT * FROM `books`")
+  .where("name", "cool-book-name")
+  .exec();
 ```
 
 [Back to top](#methods)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@casper124578/mysql.ts",
-  "version": "0.0.20",
+  "version": "0.1.0",
   "description": "A simple mysql wrapper for node.js",
   "main": "dist/index.js",
   "private": false,
@@ -46,10 +46,11 @@
     "typescript": "^4.2.4"
   },
   "prettier": {
+    "endOfLine": "auto",
     "semi": true,
     "trailingComma": "all",
     "singleQuote": false,
-    "printWidth": 120,
+    "printWidth": 100,
     "tabWidth": 2
   }
 }

package.json

@@ -3,21 +3,32 @@ import { QueryValue, BuilderTypeOptions } from "./types";
 /**
  * defaults: `nullable = true`, `length = 255`
  */
-export function string({ nullable = true, length = 255, DEFAULT }: BuilderTypeOptions = {}): string {
+export function string({
+  nullable = true,
+  length = 255,
+  DEFAULT,
+}: BuilderTypeOptions = {}): string {
   return `varchar(${length}) ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
  * defaults: `nullable = true`, `length = 8`
  */
-export function int({ nullable = true, length = 8, DEFAULT }: BuilderTypeOptions<number> = {}): string {
+export function int({
+  nullable = true,
+  length = 8,
+  DEFAULT,
+}: BuilderTypeOptions<number> = {}): string {
   return `int(${length}) ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
 /**
  * defaults: `nullable = true`
  */
-export function text({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions, "length"> = {}): string {
+export function text({
+  nullable = true,
+  DEFAULT,
+}: Omit<BuilderTypeOptions, "length"> = {}): string {
   return `text ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
@@ -31,7 +42,10 @@ export function date({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions, "len
 /**
  * defaults: `nullable = true`, `DEFAULT = {}`
  */
-export function json({ nullable = true, DEFAULT = {} }: Omit<BuilderTypeOptions<any>, "length"> = {}) {
+export function json({
+  nullable = true,
+  DEFAULT = {},
+}: Omit<BuilderTypeOptions<any>, "length"> = {}) {
   return `JSON ${_returnNullable(nullable)} ${_returnDefault(DEFAULT)}`;
 }
 
@@ -45,7 +59,10 @@ export function timestamp({ nullable = true, DEFAULT }: Omit<BuilderTypeOptions,
 /**
  * @see [https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/BuilderTypes.md#customtype](https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/BuilderTypes.md#customtype)
  */
-export function customType<T = string>(type: string, { nullable = true, DEFAULT }: BuilderTypeOptions<T>) {
+export function customType<T = string>(
+  type: string,
+  { nullable = true, DEFAULT }: BuilderTypeOptions<T>,
+) {
   return `${type} ${_returnNullable(nullable)} ${_returnDefault(DEFAULT as any)}`;
 }
 

src/BuilderTypes.ts

@@ -110,7 +110,11 @@ export class Connection<Tables> {
   }
 
   private async addReconnectHandler(connection: mysql.Connection) {
-    const ERROR_CODES = ["PROTOCOL_CONNECTION_LOST", "ECONNRESET", "PROTOCOL_ENQUEUE_AFTER_FATAL_ERROR"];
+    const ERROR_CODES = [
+      "PROTOCOL_CONNECTION_LOST",
+      "ECONNRESET",
+      "PROTOCOL_ENQUEUE_AFTER_FATAL_ERROR",
+    ];
 
     connection.once("error", (err) => {
       if (ERROR_CODES.includes(err)) {

src/Connection.ts

@@ -57,7 +57,9 @@ export class QueryBuilder<Tables, T = any> {
       return `${(data as any)[key]}`;
     });
 
-    this.query += `INSERT INTO ${tableName} (${this.createKeys(data)}) VALUES (${this.createValues(data)}) `;
+    this.query += `INSERT INTO ${tableName} (${this.createKeys(data)}) VALUES (${this.createValues(
+      data,
+    )}) `;
     this.values.push(...values);
 
     return this;
@@ -220,7 +222,11 @@ export class QueryBuilder<Tables, T = any> {
       isbn: int({ nullable: false, length: 50 }),
     }).exec()
    */
-  createTable(name: string, primary: keyof T | undefined, columns: Partial<Record<keyof T, string>>) {
+  createTable(
+    name: string,
+    primary: keyof T | undefined,
+    columns: Partial<Record<keyof T, string>>,
+  ) {
     const primaryKey = primary ? `, PRIMARY KEY (${primary})` : "";
     const values = this.createTableValues(columns);
 
@@ -233,7 +239,11 @@ export class QueryBuilder<Tables, T = any> {
    * same as `QueryBuilder#createTable` but only create the table if it doesn't exist
    * @see [https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/Query.md#create-table](https://github.com/Dev-CasperTheGhost/mysql.ts/blob/main/docs/Query.md#create-table)
    */
-  createTableIfNotExists(name: string, primary: keyof T | undefined, columns: Partial<Record<keyof T, string>>) {
+  createTableIfNotExists(
+    name: string,
+    primary: keyof T | undefined,
+    columns: Partial<Record<keyof T, string>>,
+  ) {
     const primaryKey = primary ? `, PRIMARY KEY (${primary})` : "";
     const values = this.createTableValues(columns);
 
@@ -279,7 +289,7 @@ export class QueryBuilder<Tables, T = any> {
   /**
    * execute the query
    */
-  async exec(options?: Omit<mysql.QueryOptions, "sql" | "values">): Promise<T[] | undefined> {
+  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);
@@ -299,13 +309,7 @@ export class QueryBuilder<Tables, T = any> {
           return reject(err);
         }
 
-        if (this.config.returnEmptyArrayForNoResults) {
-          return resolve(results);
-        } else {
-          if (results.length <= 0) {
-            return resolve(undefined);
-          }
-        }
+        return resolve(results);
       });
     });
   }

src/QueryBuilder.ts

@@ -8,7 +8,9 @@ import { QueryBuilder } from "./QueryBuilder";
  * @see [https://github.com/mysqljs/mysql#connection-options](https://github.com/mysqljs/mysql#connection-options)
  * @returns The connection
  */
-export async function createConnection<Tables = any>(config: ConnectionConfig): Promise<Connection<Tables>> {
+export async function createConnection<Tables = any>(
+  config: ConnectionConfig,
+): Promise<Connection<Tables>> {
   return new Connection<Tables>(config);
 }
 

src/index.ts

@@ -7,17 +7,6 @@ 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 {