diff --git a/package.json b/package.json index 27aba96..844e920 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mit.db", - "version": "2023.02.05", + "version": "2023.02.05-1", "description": "An easy and quick database", "main": "build/index.js", "types": "build/index.d.ts", diff --git a/readme.md b/readme.md index ecb0201..7d783dc 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# Map.db +# Mit.db MapDB A Map that stores data locally and loads it at startup. Written in JavaScript @@ -6,7 +6,7 @@ MapDB A Map that stores data locally and loads it at startup. Written in JavaScr Map.db works just like the JavaScript built-in **Map**, with the same methods and functionalities, and in fact it uses itself a Map, but while the built-in Map only stores data in internal memory, this module **stores data locally in a file and loads it back in the Map at startup**. -The purpose of this module is to make the JavaScript built-in Map an actual **database**, and there comes the name `map.db`: a Map that can be used as a database. +The purpose of this module is to make the JavaScript built-in Map an actual **database**, and there comes the name `mit.db`: a Map that can be used as a database. The file structure is easily accessible and the data is stored in JSON format, allowing manual editing @@ -16,13 +16,12 @@ You also have the option to only use local storage without touching internal mem Although this module works in fact the same way as a Map, there are still some little differences between them, which are listed below: -> - `MapDB#set()` and `MapDB#delete()` return **promises** -> - `Map#size` in map.db is a **method** (`MapDB#size()`) +> - `Mit#set()` and `Mit#delete()` return **promises** > - 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**. > Example: ```js -const { MapDB } = require('quickmap.db'); +const { MapDB } = require('mit.db'); const mapdb = new MapDB('file.db'); // this is the save file's name + extension async function sample() { // assuming 'somekey' exists in the Map and has a value { cool: false } @@ -40,13 +39,13 @@ async function sample() { With **npm**: -`npm i quickmap.db` +`npm i mit.db` #### Setup ```js -const { MapDB } = require('quickmap.db') +const { MapDB } = require('mit.db') const db = new MapDB('database.json') // this is the save file's name + extension ``` diff --git a/src/index.ts b/src/index.ts index aae40b9..bbce76f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,7 +5,7 @@ let writeDB: any, map: any, filename: string | undefined = 'database.db', dirnam writeDB = fsp.writeFile; -export class MapDB { +export class MitDB { /** * @constructor * @param filename If not set, MapDB will only use internal memory