2023.02.05-1
This commit is contained in:
parent
0bced72192
commit
e8a9d741dd
3 changed files with 8 additions and 9 deletions
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "mit.db",
|
"name": "mit.db",
|
||||||
"version": "2023.02.05",
|
"version": "2023.02.05-1",
|
||||||
"description": "An easy and quick database",
|
"description": "An easy and quick database",
|
||||||
"main": "build/index.js",
|
"main": "build/index.js",
|
||||||
"types": "build/index.d.ts",
|
"types": "build/index.d.ts",
|
||||||
|
|
13
readme.md
13
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
|
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**.
|
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
|
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:
|
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**
|
> - `Mit#set()` and `Mit#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**.
|
> - 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:
|
> Example:
|
||||||
|
|
||||||
```js
|
```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
|
const mapdb = new MapDB('file.db'); // this is the save file's name + extension
|
||||||
async function sample() {
|
async function sample() {
|
||||||
// assuming 'somekey' exists in the Map and has a value { cool: false }
|
// assuming 'somekey' exists in the Map and has a value { cool: false }
|
||||||
|
@ -40,13 +39,13 @@ async function sample() {
|
||||||
|
|
||||||
With **npm**:
|
With **npm**:
|
||||||
|
|
||||||
`npm i quickmap.db`
|
`npm i mit.db`
|
||||||
|
|
||||||
|
|
||||||
#### Setup
|
#### Setup
|
||||||
|
|
||||||
```js
|
```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
|
const db = new MapDB('database.json') // this is the save file's name + extension
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ let writeDB: any, map: any, filename: string | undefined = 'database.db', dirnam
|
||||||
|
|
||||||
writeDB = fsp.writeFile;
|
writeDB = fsp.writeFile;
|
||||||
|
|
||||||
export class MapDB {
|
export class MitDB {
|
||||||
/**
|
/**
|
||||||
* @constructor
|
* @constructor
|
||||||
* @param filename If not set, MapDB will only use internal memory
|
* @param filename If not set, MapDB will only use internal memory
|
||||||
|
|
Loading…
Reference in a new issue