aloedb-node - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
 	"name": "aloedb-node",
-	"version": "1.0.0",
-	"description": "NodeJS port of theDeno package AloeDB",
+	"version": "1.0.1",
+	"description": "Light local storage database for NodeJS",
 	"main": "dist/index.js",
@@ -13,2 +13,9 @@ "types": "dist/index.d.ts",
 	},
+	"keywords": [
+		"database",
+		"db",
+		"json",
+		"storage",
+		"local"
+	],
 	"engines": {
@@ -15,0 +22,0 @@ "node": "^15.5.0"

README.md

@@ -5,7 +5,8 @@ <p align="center">
 
-<h3 align="center">AloeDB</h3>
-<p align="center"><i>Light, Embeddable, NoSQL database for NodeJS</i></p>
+<h3 align="center">AloeDB-Node</h3>
+<p align="center"><i>Light local storage database for NodeJS</i></p>
 
 <p align="center">
-    <b>Work in progress of a Work in progress!</b>
+    <b>Work in progress of a Work in progress!</b><br>
+	<span>Forked from <a href="https://github.com/Kirlovon/AloeDB">Kirlovon their Deno package!</a></span>
 </p>
@@ -17,3 +18,3 @@
 
-This is a hastily writen port of the Deno package: https://github.com/Kirlovon/AloeDB
+This is a port of the Deno package: https://github.com/Kirlovon/AloeDB
 
@@ -24,3 +25,3 @@ ## Features
 -   🚀 Optimized for a large number of operations.
--   ⚖ No dependencies, even without [std](https://deno.land/std)!
+-   ⚖ No dependencies!
 -   📁 Stores data in readable JSON file.
@@ -33,3 +34,3 @@
 ```typescript
-import { Database } from "./folder/to/package/";
+import { Database } from "aloedb-node";
 ```
@@ -39,6 +40,6 @@
 
-## Example
+## Example 1 (Using a interface)
 
 ```typescript
-import { Database } from "./folder/to/package/";
+import { Database } from "aloedb-node";
 
@@ -78,1 +79,75 @@ // Structure of stored documents
 ```
+
+## Example 2 (Class without a separate interface (Also using uuids and timestamps))
+```typescript
+import { Database } from "aloedb-node";
+import { v1 as uuidv1 } from "uuid";
+
+const db = new Database<Omit<Weather, "save" | "delete" | "update">>("./db/weather.json");
+
+export class Weather {
+    id: string;
+    timestamp: number;
+    temperature: number;
+    humidity: number;
+
+    constructor(data: Omit<Weather, "save" | "delete" | "update" | "id" | "timestamp"> & Partial<Pick<Weather, "id" | "timestamp">>) {
+        this.id = data.id ?? uuidv1();
+        this.timestamp = data.timestamp ?? new Date().getTime();
+        this.temperature = data.temperature;
+        this.humidity = data.humidity;
+    }
+
+    save() {
+        return db.insertOne(this);
+    }
+
+    delete() {
+        return db.deleteOne({ id: this.id });
+    }
+
+    update() {
+        return db.updateOne({ id: this.id }, this);
+    }
+
+    static async findOne(query: Partial<Omit<Weather, "save" | "delete" | "update">>): Promise<Weather | null> {
+        const object = await db.findOne(query);
+        if (object) return new Weather(object);
+        return null;
+    }
+
+    static async findMany(query: Partial<Omit<Weather, "save" | "delete" | "update">>): Promise<Weather[]> {
+        const objects = await db.findMany(query);
+
+        return objects.map((obj) => {
+            return new Weather(obj);
+        });
+    }
+}
+```
+### Using this class
+```typescript
+// Create a new entity
+const newWeather = new Weather({temperature: 15, humidity: 32});
+await newWeather.save();
+
+// Update a existing entity
+newWeather.temperature = 16;
+newWeather.update();
+
+// Find and existing entity
+const oldWeather = await Weather.findOne({ id: "13d2e1c2-feda-498f-8540-dd92f1087161" });
+
+// Delete a existing entity
+await oldWeather.delete();
+
+// Get an array of many entities
+const moreWeathers = await Weather.findMany({});
+
+for (const weather of moreWeathers) {
+	console.log(weather.id);
+}
+```
+
+## Support
+If you want to buy someone a coffee, try to get in contact with the <a href="https://github.com/Kirlovon/AloeDB">contributors from this package</a>, they did 99.9% of the work, I just made it run in node because I was frustrated with existing packages.

No alert changes

Improved metrics

Total package byte prevSize

61962

increased by3.95%

Number of lines in readme file

147

increased by101.37%

No dependency changes