Compare commits
21 commits
v2023.02.0
...
main
Author | SHA1 | Date | |
---|---|---|---|
|
c902d92711 | ||
|
90670ebb7b | ||
|
363492aef5 | ||
|
41d589ccbc | ||
|
74f4f42e50 | ||
|
492c49a086 | ||
|
c8410b0c6f | ||
|
387ab7e582 | ||
|
e74533f1f2 | ||
|
e269f2c9d3 | ||
|
693bc03318 | ||
|
00f21b7d83 | ||
|
0d1a44eb55 | ||
234ef511fb | |||
|
e0f80728f1 | ||
|
4cc7c199c5 | ||
|
bd56815a45 | ||
bc1a6f1c43 | |||
|
6680c57b56 | ||
|
6b52d65288 | ||
678be1577f |
8 changed files with 210 additions and 142 deletions
11
.github/dependabot.yml
vendored
Normal file
11
.github/dependabot.yml
vendored
Normal file
|
@ -0,0 +1,11 @@
|
|||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "npm" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
2
.github/workflows/npm-publish.yml
vendored
2
.github/workflows/npm-publish.yml
vendored
|
@ -14,7 +14,7 @@ jobs:
|
|||
node-version: '16.x'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
scope: '@thundernetworkrad'
|
||||
- name: Install Dependency
|
||||
- name: Install Dependencies
|
||||
run: npm i
|
||||
- name: Build
|
||||
run: npm run build
|
||||
|
|
13
SECURITY.md
Normal file
13
SECURITY.md
Normal file
|
@ -0,0 +1,13 @@
|
|||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
| Version | Supported |
|
||||
| ---------- | ------------------ |
|
||||
| 2023.02.06 | ✅ |
|
||||
| 2023.02.05 | ✅ |
|
||||
| < 2023.02 | ❌ |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
For report a vulnerability pls go [Here](https://github.com/ThunderNetworkRaD/mit.db/issues), open a new issue.
|
18
package.json
18
package.json
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "mit.db",
|
||||
"version": "2023.02.05-2",
|
||||
"version": "2023.04.12",
|
||||
"description": "An easy and quick database",
|
||||
"main": "build/index.js",
|
||||
"types": "build/index.d.ts",
|
||||
|
@ -9,19 +9,17 @@
|
|||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/ThunderNetworkRaD/map.db.git"
|
||||
"url": "git+https://github.com/ThunderNetworkRaD/mit.db.git"
|
||||
},
|
||||
"author": "Thunder Network Development | Killer Boss Original",
|
||||
"author": "ThunderNetworkRaD | Killer Boss Original",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://github.com/ThunderNetworkRaD/map.db/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ThunderNetworkRaD/map.db#readme",
|
||||
"dependencies": {
|
||||
"tslib": "^2.4.1",
|
||||
"typescript": "^4.9.5"
|
||||
"url": "https://github.com/ThunderNetworkRaD/mit.db/issues"
|
||||
},
|
||||
"homepage": "https://github.com/ThunderNetworkRaD/mit.db#readme",
|
||||
"devDependencies": {
|
||||
"@types/node": "^18.11.19"
|
||||
"@types/node": "^18.14.0",
|
||||
"tslib": "^2.4.1",
|
||||
"typescript": "^5.0.3"
|
||||
}
|
||||
}
|
||||
|
|
91
readme.md
91
readme.md
|
@ -1,34 +1,14 @@
|
|||
# Mit.db
|
||||
|
||||
MapDB A Map that stores data locally and loads it at startup. Written in JavaScript
|
||||
|
||||
### How does it work?
|
||||
|
||||
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 `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
|
||||
|
||||
You also have the option to only use local storage without touching 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:
|
||||
|
||||
> - `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('mit.db');
|
||||
const mapdb = new MapDB('file.db'); // this is the save file's name + extension
|
||||
const MitDB = require('mit.db');
|
||||
const db = new MitDB('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 }
|
||||
const data = mapdb.get('somekey');
|
||||
const data = db.get('somekey');
|
||||
// reassigning the 'cool' property a new value
|
||||
data.cool = true;
|
||||
await mapdb.set('somekey', data);
|
||||
await db.set('somekey', data);
|
||||
// now 'somekey' has a new value { cool: true }
|
||||
}
|
||||
```
|
||||
|
@ -45,18 +25,73 @@ With **npm**:
|
|||
#### Setup
|
||||
|
||||
```js
|
||||
const { MapDB } = require('mit.db')
|
||||
const db = new MapDB('database.json') // this is the save file's name + extension
|
||||
const MitDB = require('mit.db')
|
||||
const db = new MitDB('database.json') // this is the save file's name + extension
|
||||
```
|
||||
|
||||
#### set()
|
||||
|
||||
```js
|
||||
await db.set('what', 'how')
|
||||
await db.set('ciao', 'hello')
|
||||
await db.set('arrivederci', 'bye')
|
||||
```
|
||||
|
||||
#### get()
|
||||
|
||||
```js
|
||||
var answ = db.get('what') // answ = how
|
||||
var ansa = db.get('ciao') // ansa = hello
|
||||
```
|
||||
|
||||
#### has()
|
||||
|
||||
```js
|
||||
var asnb = db.has('arrivederci') // ansb = true
|
||||
```
|
||||
|
||||
#### entries()
|
||||
|
||||
```js
|
||||
var ansc = db.entries() // ansc = [ 'ciao', 'hello' ], [ 'arrivederci', 'bye' ] ]
|
||||
```
|
||||
|
||||
#### keys()
|
||||
|
||||
```js
|
||||
var ansd = db.keys() // ansd = [ 'ciao', 'arrivederci' ]
|
||||
```
|
||||
|
||||
#### values()
|
||||
|
||||
```js
|
||||
var anse = db.values() // anse = [ 'hello', 'bye' ]
|
||||
```
|
||||
|
||||
#### forEach()
|
||||
|
||||
```js
|
||||
db.forEach((value, key) => console.log(value, key)) // console.log = hello ciao
|
||||
// console.log = bye arrivederci
|
||||
```
|
||||
|
||||
#### delete()
|
||||
|
||||
```js
|
||||
// [{"key":"ciao","value":"hello"}, {"key":"arrivederci","value":"bye"}]
|
||||
await db.delete('ciao')
|
||||
// [{"key":"arrivederci","value":"bye"}]
|
||||
```
|
||||
|
||||
#### clear()
|
||||
|
||||
```js
|
||||
// [{"key":"ciao","value":"hello"}, {"key":"arrivederci","value":"bye"}]
|
||||
await db.delete('ciao')
|
||||
// []
|
||||
```
|
||||
|
||||
#### size()
|
||||
|
||||
```js
|
||||
// [{"key":"ciao","value":"hello"}, {"key":"arrivederci","value":"bye"}]
|
||||
var ansf = db.size() // size = 2
|
||||
```
|
|
@ -1,62 +0,0 @@
|
|||
# Map.db
|
||||
|
||||
MapDB A Map that stores data locally and loads it at startup. Written in JavaScript
|
||||
|
||||
### How does it work?
|
||||
|
||||
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 file structure is easily accessible and the data is stored in JSON format, allowing manual editing
|
||||
|
||||
You also have the option to only use local storage without touching 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:
|
||||
|
||||
> - `MapDB#set()` 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 = 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 }
|
||||
const data = mapdb.get('somekey');
|
||||
// reassigning the 'cool' property a new value
|
||||
data.cool = true;
|
||||
await mapdb.set('somekey', data);
|
||||
// now 'somekey' has a new value { cool: true }
|
||||
}
|
||||
```
|
||||
|
||||
### Docs
|
||||
|
||||
#### Installation
|
||||
|
||||
With **npm**:
|
||||
|
||||
`npm i quickmap.db`
|
||||
|
||||
|
||||
#### Setup
|
||||
|
||||
```js
|
||||
const { MapDB } = require('quickmap.db')
|
||||
const db = new MapDB('database.json') // this is the save file's name + extension
|
||||
```
|
||||
|
||||
#### set()
|
||||
|
||||
```js
|
||||
await db.set('what', 'how')
|
||||
```
|
||||
|
||||
#### get()
|
||||
|
||||
```js
|
||||
var answ = db.get('what') // answ = how
|
||||
```
|
154
src/index.ts
154
src/index.ts
|
@ -1,72 +1,146 @@
|
|||
import fsp from "fs/promises";
|
||||
import fs from "fs";
|
||||
import { promisify } from 'util';
|
||||
import * as fs from 'fs';
|
||||
|
||||
let writeDB: any, map: any, filename: string | undefined = 'database.db', dirname: string = './data/', db: any, file: any, data: any;
|
||||
const writeDB = promisify(fs.writeFile);
|
||||
|
||||
writeDB = fsp.writeFile;
|
||||
class MitDB {
|
||||
readonly db;
|
||||
filename: string;
|
||||
options: any;
|
||||
dirname: string;
|
||||
|
||||
export class MitDB {
|
||||
/**
|
||||
* @constructor
|
||||
* @param filename If not set, MapDB will only use internal memory
|
||||
* @example 'file.db'
|
||||
* @param options Options to pass to the constructor
|
||||
* @param options.dirname
|
||||
* @example 'data'
|
||||
* @param options Options to pass in the constructor
|
||||
* @param options.dirname where to put the database?
|
||||
*/
|
||||
constructor(fn: string | undefined, options: any) {
|
||||
map = new Map();
|
||||
constructor(filename: string, options?: { dirname: string }) {
|
||||
if (options && options.dirname) {
|
||||
this.dirname = options.dirname;
|
||||
} else {
|
||||
this.dirname = 'data';
|
||||
}
|
||||
|
||||
if (fn) filename = fn;
|
||||
this.filename = filename;
|
||||
|
||||
if (options.dirname) dirname = options.dirname;
|
||||
if (!fs.existsSync(this.dirname)) fs.mkdirSync(this.dirname);
|
||||
|
||||
if (!fs.existsSync(dirname)) fs.mkdirSync(dirname);
|
||||
|
||||
db = `./${dirname}/${filename}`
|
||||
|
||||
try {
|
||||
file = fs.readFileSync(db);
|
||||
data = JSON.parse(file.toString());
|
||||
|
||||
for (let i = 0; i < data.length; i++) {
|
||||
map.set(data[i].key, data[i].value);
|
||||
}
|
||||
} catch {}
|
||||
this.db = `./${this.dirname}/${this.filename}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param key
|
||||
* @param value
|
||||
*
|
||||
* @param key
|
||||
* @param value
|
||||
*/
|
||||
async set(key: string | number, value: any) {
|
||||
try {
|
||||
file = fs.readFileSync(db);
|
||||
data = JSON.parse(data);
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
const i = data.findIndex((pair: any) => pair.key == key);
|
||||
|
||||
let i = data.findIndex((pair: any) => pair.key == key);
|
||||
!data[i] ? data.push({ key, value }) : data[i] = { key, value };
|
||||
|
||||
await writeDB(db, JSON.stringify(data));
|
||||
await writeDB(this.db, JSON.stringify(data));
|
||||
return data;
|
||||
} catch {
|
||||
await await writeDB(db, `[${JSON.stringify({ key, value })}]`)
|
||||
await writeDB(this.db, `[${JSON.stringify({ key, value })}]`).then(() => {
|
||||
return JSON.parse(fs.readFileSync(this.db).toString());
|
||||
});
|
||||
}
|
||||
|
||||
return map.set(key, value)
|
||||
return 'error'
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param key
|
||||
*/
|
||||
|
||||
get(key: string | number) {
|
||||
if (map) {
|
||||
return map.get(key)
|
||||
} else {
|
||||
file = fs.readFileSync(db);
|
||||
data = JSON.parse(file.toString());
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.find((pair: any) => pair.key == key)?.value || undefined;
|
||||
}
|
||||
return data.find((pair: any) => pair.key == key)?.value || undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param key
|
||||
*/
|
||||
has(key: string | number) {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.find((pair: any) => pair.key == key) ? true : false;
|
||||
}
|
||||
|
||||
entries() {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.map((pair: any) => [pair.key, pair.value]);
|
||||
}
|
||||
|
||||
keys() {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.map((pair: any) => pair.key);
|
||||
}
|
||||
|
||||
values() {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.map((pair: any) => pair.value);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param callbackfilename
|
||||
*/
|
||||
forEach(callback: (value: any, key: any) => void) {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
data.forEach((pair: any) => callback(pair.value, pair.key));
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param key
|
||||
*/
|
||||
async delete(key: string | number) {
|
||||
try {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
const i = data.findIndex((pair: any) => pair.key == key);
|
||||
|
||||
if (data[i]) {
|
||||
data.splice(i, 1);
|
||||
await writeDB(this.db, JSON.stringify(data));
|
||||
|
||||
return true;
|
||||
}
|
||||
} catch {}
|
||||
return 'error';
|
||||
}
|
||||
|
||||
async clear() {
|
||||
await writeDB(this.db, JSON.stringify([])).catch(() => {});
|
||||
}
|
||||
|
||||
size() {
|
||||
const file = fs.readFileSync(this.db);
|
||||
const data: any[] = JSON.parse(file.toString());
|
||||
|
||||
return data.length;
|
||||
}
|
||||
}
|
||||
|
||||
export = MitDB;
|
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue