https://github.com/megalithofficial/meg.db-light
MegDB-light, A lightweight TypeScript database module providing a type-safe API for efficient data storage and retrieval. Easily extendable with custom drivers, including a built-in JSONDriver.
https://github.com/megalithofficial/meg.db-light
begginer-friendly custom-driver customisable database easy-to-use fast javascript json lightweight node-js quickdb type-safe typescript
Last synced: 6 months ago
JSON representation
MegDB-light, A lightweight TypeScript database module providing a type-safe API for efficient data storage and retrieval. Easily extendable with custom drivers, including a built-in JSONDriver.
- Host: GitHub
- URL: https://github.com/megalithofficial/meg.db-light
- Owner: MegalithOfficial
- License: gpl-3.0
- Created: 2024-01-29T11:57:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T07:15:31.000Z (8 months ago)
- Last Synced: 2024-11-08T07:45:00.598Z (7 months ago)
- Topics: begginer-friendly, custom-driver, customisable, database, easy-to-use, fast, javascript, json, lightweight, node-js, quickdb, type-safe, typescript
- Language: TypeScript
- Homepage:
- Size: 44.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# MegDB-light: A Robust TypeScript Database Module 🚀
MegDB-light is a robust, lightweight database module crafted in TypeScript. It offers a user-friendly and extensible API for seamless data manipulation, enabling you to execute common operations such as set, get, delete, and more with ease. The module's design is flexible, accommodating different data storage drivers.
## Key Features
- **Super Lightweight:** MegDB-light is incredibly lightweight, ensuring your applications remain efficient and high-performing. 🚀
- **Type-Safe Operations:** MegDB-light exploits TypeScript’s type system to ensure type safety across your database interactions, enhancing reliability and robustness. 🛡️
- **Extensibility:** MegDB-light is easily extendable. You can implement custom data storage drivers, making the module compatible with a variety of storage solutions. 📚
## Installation
You can incorporate MegDB-light into your TypeScript project by installing it via npm:
```bash
npm install meg.db-light
```
## How to Use
### MegDB Class
The `Megdb` class offers a high-level API for data interaction.
```typescript
import { Megdb, JSONDriver } from 'meg.db-light';
// Define a type for the data
interface User {
name: string;
age: number;
hobbies: string[];
};
interface format {
"john": User;
};
// Create a new JSONDriver instance
const jsonDriver = new JSONDriver('users.json');
// Create a new Megdb instance with the JSONDriver instance
const megDB = new Megdb(jsonDriver);
async function main() {
// Set a value
await megDB.set('john', { name: 'John Doe', age: 30, hobbies: ['reading', 'coding'] });
// Get a value
const john = await megDB.get('john');
console.log(john!.name); // Outputs: John Doe
// Update a value
await megDB.add('john.age', 1);
// Get the updated value
const updatedJohn = await megDB.get('john.age');
console.log(updatedJohn); // Outputs: 31
// Push a value into an array
await megDB.push('john.hobbies', "gaming");
// Get the updated array
const updatedHobbies = await megDB.get('john.hobbies');
console.log(updatedHobbies); // Outputs: ['reading', 'coding', 'gaming']
// Pull a value from an array
await megDB.filter('john.hobbies', hobby => hobby !== 'coding');
// Get the updated array
const finalHobbies = await megDB.get('john.hobbies');
console.log(finalHobbies); // Outputs: ['reading', 'gaming']
// Delete a value
await megDB.delete('john.age');
// Try to get the deleted value
const deletedValue = await megDB.get('john.age');
console.log(deletedValue); // Outputs: undefined
// Get the type of the 'john.hobbies' property
const typeofhobbies = await megDB.typeof('john.hobbies');
console.log(typeofhobbies); // Outputs: object
// Get the type of the 'john.name' property
const typeofname = await megDB.typeof('john.name');
console.log(typeofname); // Outputs: string
// Get all data
const allData = await megDB.all();
console.log(allData); // Outputs: { john: { name: 'John Doe', hobbies: ['reading', 'gaming'] } }
};
main();
```
### Custom Driver
You can create your custom driver by extending the `BaseDriver` class and implementing the `loadData` and `saveData` methods.
```typescript
import { BaseDriver } from 'meg.db-light';
export class CustomDriver extends BaseDriver {
constructor(filePath: string) {
super(filePath);
}
public async loadData(): Promise {
// Implement loading data from your custom storage
}
public async saveData(data: T): Promise {
// Implement saving data to your custom storage
}
}
```
## Examples
### JSONDriver
A built-in driver for storing data in a JSON file.
```typescript
import { Megdb } from 'meg.db-light';
import { JSONDriver } from 'megdb/drivers/JSONDriver';
// Define a type for the data
interface User {
name: string;
age: number;
hobbies: string[];
};
interface format {
"john": User;
};
// Create a new JSONDriver instance
const jsonDriver = new JSONDriver('users.json');
// Create a new Megdb instance with the JSONDriver instance
const megDB = new Megdb(jsonDriver);
async function main() {
// Operations with MegDB...
}
main();
```
## License
This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.