Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sabrydawood/dev.db
A lightweight, 0 dependency, easy-to-use local database using JSON to store data
https://github.com/sabrydawood/dev.db
Last synced: about 2 months ago
JSON representation
A lightweight, 0 dependency, easy-to-use local database using JSON to store data
- Host: GitHub
- URL: https://github.com/sabrydawood/dev.db
- Owner: sabrydawood
- License: mit
- Created: 2022-11-20T19:43:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-21T16:51:18.000Z (about 2 years ago)
- Last Synced: 2024-04-24T22:22:00.241Z (9 months ago)
- Language: JavaScript
- Size: 131 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#VirusDB
[](https://www.npmjs.com/package/dev.db)
[](https://www.npmjs.com/package/dev.db)
[](https://www.npmjs.com/package/dev.db)
[](https://packagequality.com/#?package=dev.db)
A lightweight, 0 dependency, easy-to-use local database using JSON to store data.
- **[Documentation](https://clony.vercel.app)**
- **[Yarn Package](https://yarnpkg.com/package/dev.db)**
- **[NPM Package](https://npmjs.com/package/dev.db)**
- **[NPM Package Statistics](https://npm-stat.com/charts.html?package=dev.db&from=2021-05-07)**
Installation
------------
```sh-session
npm install dev.db
yarn add dev.db
```
Example Usage
-------------
### JsonDatabase
```js
const VirusDB = require('dev.db');
const db = new VirusDB();
db.set('money', 100);
db.set('person.name', 'virus');
db.has('money'); // true
db.has('person.name'); // true
db.has('person.age'); // false
db.get('person.name'); // 'virus'
db.get('person.job'); // undefined
db.toJSON(); // { money: 100, person: { name: 'virus' } }
```
### JsonCollections
```js
const dbConfig = {
autoSave: false,
encryptionKey: 'qwertyuiopasdfghjkpzxxcvbnm',
dataFile: 'database/dev.db.json',
collectionsFolder: 'database/collections'
}
const VirusDB = require('dev.db');
const db = new VirusDB(dbConfig);
const Users = db.createCollection('users');
Users.create({ name: 'virus', age: 19 });
Users.create({ name: 'virus24', age: 19 });
Users.update(
user => user.age = 20,
target => target.name === 'virus'
);
// or ([email protected]+)
const user = Users.get(target => target.name === 'virus');
user.age = 20;
user.save();
Users.get(user => user.name === 'virus'); // { name: 'virus', age: 20 }
Users.getMany(user => user.age > 18); // [{ name: 'virus', age: 20 }, { name: 'virus24', age: 19 }]
```
### With TypeScript:
```ts
import { JsonDatabase, Modifiable } from 'dev.db';
const dbConfig = {
autoSave: false,
encryptionKey: 'qwertyuiopasdfghjkpzxxcvbnm',
dataFile: 'database/dev.db.json',
collectionsFolder: 'database/collections'
}
const db = new JsonDatabase(dbConfig);
type User = {
name: string
age: number
}
const Users = db.createCollection('users');
Users.create({ name: 'virus', age: 19 });
Users.create({ name: 'virus24', age: 19 });
Users.update(
user => user.age = 20,
target => target.name === 'virus'
);
// or ([email protected]+)
const user = > Users.get(target => target.name === 'virus');
user.age = 20;
user.save();
Users.get(user => user.name === 'virus'); // { name: 'virus', age: 20 }
Users.getMany(user => user.age > 18); // [{ name: 'virus', age: 20 }, { name: 'virus24', age: 19 }]
```
Contributing
------------
Before [creating an issue](https://github.com/virgel1995/dev.db/issues), please ensure that it hasn't already been reported or suggested.
When [submitting a new pull request](https://github.com/virgel1995/dev.db/pulls), please make sure the code style/format used is the same as the one used in the original code.
License
-------
Refer to the [LICENSE](LICENSE) file.