feat: v5 (#42)

Author: sksmta

.github/workflows/eslint.yml

@@ -20,10 +20,7 @@ jobs:
           node-version: 16
 
       - name: Install dependencies
-        run: npm install
+        run: yarn install
 
       - name: Run ESLint
-        run: npm run lint
-
-      - name: Run TSC
-        run: npm run build:check
+        run: yarn lint

.gitignore

@@ -5,3 +5,4 @@ test/
 .vscode/
 yarn.lock
 package-lock.json
+globalConfig.json

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Snowflake Studio ❄️
+Copyright (c) 2022 CesiumLabs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -7,7 +7,6 @@ Quick Mongodb wrapper for beginners that provides key-value based interface.
 # Installing
 
 ```bash
-$ npm install --save mongodb # required
 $ npm install --save quickmongo
 ```
 
@@ -16,7 +15,6 @@ $ npm install --save quickmongo
 
 # Features
 - Beginner friendly
-- Strongly typed
 - Asynchronous
 - Dot notation support
 - Key-Value like interface
@@ -25,55 +23,47 @@ $ npm install --save quickmongo
 # Example
 
 ```js
-const { Collection: MongoCollection, MongoClient } = require("mongodb");
-const { Collection, Fields } = require("quickmongo");
-
-const mongo = new MongoClient("mongodb://localhost/quickmongo");
-const schema = new Fields.ObjectField({
-    difficulty: new Fields.StringField(),
-    items: new Fields.ArrayField(new Fields.StringField()),
-    balance: new Fields.NumberField()
+const { Database } = require("quickmongo");
+
+const db = new Database("mongodb://localhost/quickmongo");
+
+db.on("ready", () => {
+    console.log("Connected to the database");
+    doStuff();
 });
 
-mongo.connect()
-    .then(() => {
-        console.log("Connected to the database!");
-        doStuff();
-    });
+db.connect();
 
 function doStuff() {
-    const mongoCollection = mongo.db().collection("JSON");
-
-    const db = new Collection(mongoCollection, schema);
-    
-    db.set("userInfo", { difficulty: "Easy", items: [], balance: 0 }).then(console.log);
-    // -> { difficulty: 'Easy', items: [], balance: 0 }
+    // Setting an object in the database:
+    await db.set("userInfo", { difficulty: "Easy" });
+    // -> { difficulty: 'Easy' }
 
-    db.push("userInfo", "Sword", "items").then(console.log);
-    // -> { difficulty: 'Easy', items: ['Sword'], balance: 0 }
+    // Pushing an element to an array (that doesn't exist yet) in an object:
+    await db.push("userInfo.items", "Sword");
+    // -> { difficulty: 'Easy', items: ['Sword'] }
 
-    db.set("userInfo", 500, "balance").then(console.log);
+    // Adding to a number (that doesn't exist yet) in an object:
+    await db.add("userInfo.balance", 500);
     // -> { difficulty: 'Easy', items: ['Sword'], balance: 500 }
 
     // Repeating previous examples:
-    db.push("userInfo", "Watch", "items").then(console.log);
+    await db.push("userInfo.items", "Watch");
     // -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }
-
-    const previousBalance = await db.get("userInfo", "balance");
-    db.set("userInfo", previousBalance + 500, "balance").then(console.log);
+    await db.add("userInfo.balance", 500);
     // -> { difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 }
 
     // Fetching individual properties
-    db.get("userInfo", "balance").then(console.log);
-    // -> 1000
-    db.get("userInfo", "items").then(console.log);
-    // -> ['Sword', 'Watch']
+    await db.get("userInfo.balance"); // -> 1000
+    await db.get("userInfo.items"); // -> ['Sword', 'Watch']
 
     // remove item
     db.pull("userInfo", "Sword", "items").then(console.log);
     // -> { difficulty: 'Easy', items: ['Watch'], balance: 1000 }
 }
 ```
 
+**Created and maintained by CesiumLabs**
+
 # Discord Support
-**[SnowflakeDev Community ❄️](https://snowflakedev.org/discord)**
+**[CesiumLabs](https://discord.gg/uqB8kxh)**