🎉 NEW: 0.0.1

Author: casperiv0

.eslintrc.json

@@ -25,6 +25,7 @@
     "no-useless-catch": ["warn"],
     "prettier/prettier": ["error"],
     "@typescript-eslint/no-explicit-any": "off",
-    "@typescript-eslint/explicit-module-boundary-types": "off"
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "prefer-rest-params": "off"
   }
 }

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.0.1
+
+- Initial release
+- Add documentation
+
+## 0.0.0-alpha
+
+- Initial version

docs/Query.md

@@ -0,0 +1,92 @@
+# Query
+
+## Table of contents
+
+- [Select](#select)
+- [Insert](#insert)
+- [Update](#update)
+- [Delete](#delete)
+- [Raw](#raw)
+- [All methods](#all-methods)
+
+## Select
+
+```ts
+const connection = await createConnection({
+  /* ... */
+});
+
+const books = await connection.query.select("*").from("books").where("name", "some-book-name").exec();
+```
+
+## Insert
+
+```ts
+const connection = await createConnection({
+  /* ... */
+});
+
+const data = {
+  id: 1,
+  name: "book-name",
+};
+
+const result = await connection.query.insert("books", data).exec();
+```
+
+## Update
+
+```ts
+const connection = await createConnection({
+  /* ... */
+});
+
+const data = {
+  id: 1,
+  name: "book-name",
+};
+
+const result = await connection.query.update("books", data).where("id", data.id).exec();
+```
+
+## Delete
+
+```ts
+const connection = await createConnection({
+  /* ... */
+});
+
+const result = await connection.query.delete("books").where("name", "book-name").exec();
+```
+
+## Raw
+
+```ts
+const connection = await createConnection({
+  /* ... */
+});
+
+// Full raw query
+const result = await connection.query.raw("SELECT * FROM `books`").exec();
+
+const result = await connection.query
+  .raw("INSERT INTO `books` (`id`, `name`) VALUES (?, ?)", ["2", "book-name"])
+  .exec();
+
+// With chaining
+const result = await connection.query.raw("SELECT * FROM `books`").where("name", "cool-book-name").exec();
+```
+
+## All methods
+
+- `select`
+- `from`
+- `insert`
+- `update`
+- `delete`
+- `where`
+- `order`
+- `limit`
+- `having`
+- `raw`
+- `exec`

docs/README.md

@@ -30,3 +30,7 @@ async function init() {
   console.log(results);
 }
 ```
+
+## More
+
+- [Query](./Query.md)

docs/connection.md

@@ -1,6 +1,6 @@
 {
   "name": "mysql.ts",
-  "version": "0.0.0-alpha",
+  "version": "0.0.1",
   "description": "A simple mysql wrapper for node.js",
   "main": "dist/index.js",
   "scripts": {

package-lock.json

@@ -45,7 +45,6 @@ export class QueryBuilder {
    */
   insert<T = Record<string, unknown>>(tableName: string, data: T) {
     const values = Object.keys(data).map((key) => {
-      // eslint-disable-next-line
       return `${(data as any)[key]}`;
     });
 
@@ -80,10 +79,10 @@ export class QueryBuilder {
    * @param selector The table name
    * @example
    * // delete an item with 'where'
-   * <Connection>.query.delete("books").where("name", "cool-book-name");
+   * <Connection>.query.delete("books").where("name", "cool-book-name").exec();
    *
    * // delete all items from table
-   * <Connection>.query.delete("books");
+   * <Connection>.query.delete("books").exec();
    */
   delete(selector: string) {
     this.query = `DELETE FROM ${selector} `;
@@ -116,9 +115,21 @@ export class QueryBuilder {
     return this;
   }
 
-  raw(query: string, values: unknown[]) {
-    this.query = query;
-    this.values = values;
+  /**
+   * Create a raw query
+   * @param query The raw query
+   * @param values Values that are needed for insert, update, ..
+   * @example
+   *
+   * // Full raw query
+   * <Connection>.query.raw("SELECT * FROM `books`").exec();
+   *
+   * // With chaining
+   * <Connection>.query.raw("SELECT * FROM `books`").where("name", "cool-book-name").exec();
+   */
+  raw(query: string, values?: unknown[]) {
+    this.query = `${query} `;
+    this.values = values ?? [];
 
     return this;
   }

package.json

@@ -9,15 +9,13 @@ async function test() {
     reconnect: true,
   });
 
-  const sql = conn.query.select("*").from("citizens").order("full_name", "ASC");
+  // const sql = conn.query.select("*").from("citizens").order("full_name", "ASC");
+  const sql = conn.query.raw("SELECT * FROM `citizens`").where("id", "a22e0c79-5ecd-4012-85bb-a214196e2d72");
 
   // 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);
+  result;
 
   await conn.end();
 }