feat: emit events on ready and end

Emit events on client connect and client end, and returns the Client on `connect()` and `end()` functions. Tests updated accordingly.

Author: GodderE2D

src/index.ts

@@ -1,3 +1,4 @@
+import EventEmitter from "events";
 import { Client as PgClient } from "pg";
 
 import add from "./methods/add";
@@ -41,20 +42,27 @@ export type Methods =
   | "all"
   | "type";
 
-export class Client {
+export class Client extends EventEmitter {
   protected dbUrl: string;
   protected options: ClientOptions | undefined;
-  protected client: PgClient;
   protected tableName: string | undefined;
 
+  /**
+   * The `pg` client instance for your database.
+   */
+
+  public client: PgClient;
+
   /**
    * Whether the database has been connected or not.
    * @see connect
    * @see end
    */
+
   public connected: boolean;
 
   constructor(dbUrl: string, options?: ClientOptions) {
+    super();
     this.dbUrl = dbUrl;
     this.options = options;
     this.tableName = options?.table ?? undefined;
@@ -64,23 +72,28 @@ export class Client {
 
   /**
    * Connects to the database specified when creating the client.
-   * @returns void
+   * @returns the client
    * @example await db.connect();
    */
 
   public async connect() {
     await this.client.connect();
     this.connected = true;
+    this.emit("ready", this);
+    return this;
   }
 
   /**
    * Ends the connection to the database specified when creating the client.
+   * @returns the client
    * @example await db.end();
    */
 
   public async end() {
     await this.client.end();
     this.connected = false;
+    this.emit("end", this);
+    return this;
   }
 
   /**

tests/test.js

@@ -30,9 +30,14 @@ class Test {
   }
 }
 
+db.on("ready", () => console.log("ℹ️ Database connected"));
+db.on("end", () => console.log("ℹ️ Database connection ended"));
+
 (async () => {
   await db.connect();
 
+  console.time("Time to test (excludes connection & end)");
+
   await db.set("users.0", {
     username: "Zero",
     email: "[email protected]",
@@ -79,6 +84,8 @@ class Test {
   // Test 13
   new Test(await db.type("users.0.points")).test("number");
 
+  console.timeEnd("Time to test (excludes connection & end)");
+
   await db.drop();
   await db.end();