deleteDocument Function

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.4
+
+- Added deleteDocument function
+
 # 1.0.3
 
 - Simplify `onSync` logic to just pass any entity.

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stuyk/cross-resource-cache",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "description": "add mongodb database saving to cross resource environments for altv",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",

src/database/index.ts

@@ -280,3 +280,24 @@ export async function getAll<T extends { _id: ObjectId }>(
         return undefined;
     }
 }
+
+/**
+ * Deletes a single document by `_id`
+ *
+ * If the document was deleted it will return `true`.
+ *
+ * @export
+ * @param {string} _id
+ * @param {string} collection
+ * @return {Promise<boolean>}
+ */
+export async function deleteDocument(_id: string, collection: string): Promise<boolean> {
+    const client = await getMongoClient();
+
+    try {
+        const result = await client.collection(collection).deleteOne({ _id: new ObjectId(_id) });
+        return result.acknowledged;
+    } catch (err) {
+        return false;
+    }
+}