@galaxy05/map.db 1.2.2 → 1.3.0

package/README.md

@@ -13,10 +13,10 @@ The file structure is easily accessible and the data is stored in JSON format, a
 
 ![image](img2.png)
 
-You also have the option to only use local storage without touching internal memory
+You also have the option to only use local storage, disabling internal memory
 
 ### Differences
-Although this module works in fact the same way as a Map, there are still some little differences between them, which are listed below:
+Although this module works in fact the same way as a Map, there are a few differences between them, which are listed below:
 > - `MapDB#set()` and `MapDB#delete()` return **promises**
 > - `Map#size` in map.db is a **method** (`MapDB#size()`)
 > - When a value is reassigned to a key, it is only saved in the Map but not in the actual save file, so you always have to **set the key/value pair with the new value**.
@@ -46,4 +46,4 @@ With **npm**:
 
 With **yarn**:
 
-`yarn add @galaxy05/map.db`
+`yarn add @galaxy05/map.db`

package/build/index.js

@@ -35,27 +35,30 @@ var __importStar = (this && this.__importStar) || (function () {
 const util_1 = require("util");
 const fs = __importStar(require("fs"));
 const writeDB = (0, util_1.promisify)(fs.writeFile);
-const deleteDB = (0, util_1.promisify)(fs.unlink);
+// const deleteDB = promisify(fs.unlink);
 class MapDB {
     map;
     filename;
     db;
     options;
+    path;
     /**
      * @constructor
      * @param filename If not set, MapDB will only use internal memory
      * @example 'file.db'
      * @param options Options to pass in the constructor
-     * @param options.localOnly When enabled, MapDB will only use local storage, without touching internal memory (requires a filename)
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
      */
     constructor(filename, options) {
         if (!filename && options?.localOnly)
             throw new Error('Cannot use local storage without a filename');
         this.map = !options?.localOnly ? new Map() : null;
         this.filename = filename;
-        if (!fs.existsSync('./data/'))
-            fs.mkdirSync('./data');
-        this.db = this.filename ? `./data/${this.filename}` : null;
+        this.path = options.path ?? '.';
+        if (!fs.existsSync(`${this.path}/data/`))
+            fs.mkdirSync(`${this.path}/data`);
+        this.db = this.filename ? `${this.path}/data/${this.filename}` : null;
         if (this.map && this.db) {
             try {
                 const file = fs.readFileSync(this.db);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galaxy05/map.db",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "A Map that stores data locally and loads it at startup",
   "types": "types/index.d.ts",
   "main": "build/index.js",
@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/GalaxyVinci05/map.db#readme",
   "devDependencies": {
-    "@types/node": "^24.10.1"
+    "@types/node": "^25.2.0"
   },
   "dependencies": {
     "typescript": "^5.9.3"

package/src/index.ts

@@ -2,30 +2,33 @@ import { promisify } from 'util';
 import * as fs from 'fs';
 
 const writeDB = promisify(fs.writeFile);
-const deleteDB = promisify(fs.unlink);
+// const deleteDB = promisify(fs.unlink);
 
 class MapDB {
     readonly map;
     filename: string;
     readonly db;
-    options: any;
+    options: MapDBOptions;
+    private path: string;
 
     /**
      * @constructor
      * @param filename If not set, MapDB will only use internal memory
      * @example 'file.db'
      * @param options Options to pass in the constructor
-     * @param options.localOnly When enabled, MapDB will only use local storage, without touching internal memory (requires a filename)
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
      */
-    constructor(filename?: string, options?: { localOnly: boolean }) {
+    constructor(filename?: string, options?: MapDBOptions) {
         if (!filename && options?.localOnly) throw new Error('Cannot use local storage without a filename');
 
         this.map = !options?.localOnly ? new Map() : null;
         this.filename = filename;
+        this.path = options.path ?? '.';
         
-        if (!fs.existsSync('./data/')) fs.mkdirSync('./data');
+        if (!fs.existsSync(`${this.path}/data/`)) fs.mkdirSync(`${this.path}/data`);
 
-        this.db = this.filename ? `./data/${this.filename}` : null;
+        this.db = this.filename ? `${this.path}/data/${this.filename}` : null;
         
         if (this.map && this.db) {
             try {
@@ -197,4 +200,9 @@ class MapDB {
     }
 }
 
-export = MapDB;
+interface MapDBOptions {
+    localOnly?: boolean;
+    path?: string;
+}
+
+export = MapDB;

package/types/index.d.ts

@@ -2,17 +2,17 @@ declare class MapDB {
     readonly map: Map<any, any>;
     filename: string;
     readonly db: string;
-    options: any;
+    options: MapDBOptions;
+    private path;
     /**
      * @constructor
      * @param filename If not set, MapDB will only use internal memory
      * @example 'file.db'
      * @param options Options to pass in the constructor
-     * @param options.localOnly When enabled, MapDB will only use local storage, without touching internal memory (requires a filename)
+     * @param options.localOnly Disable internal memory
+     * @param options.path Optional existing path to save the MapDB data directory
      */
-    constructor(filename?: string, options?: {
-        localOnly: boolean;
-    });
+    constructor(filename?: string, options?: MapDBOptions);
     /**
      *
      * @param key
@@ -45,4 +45,8 @@ declare class MapDB {
     clear(): Promise<void>;
     size(): number;
 }
+interface MapDBOptions {
+    localOnly?: boolean;
+    path?: string;
+}
 export = MapDB;