https://github.com/angelhtml/cakebase-document
https://github.com/angelhtml/cakebase-document
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/angelhtml/cakebase-document
- Owner: angelhtml
- Created: 2022-11-13T18:28:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-06T22:38:10.000Z (over 2 years ago)
- Last Synced: 2025-06-10T07:43:43.808Z (about 1 year ago)
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Cakebase
Cakebase is an asynchronous fast json database that allows you to efficiently and easily edit, search or add objects.
This project has been optimized and improved with some updates for 2 years now. Cakebase is currently only available in Nodejs.
Here are a few [examples](https://github.com/erwinkulasic/Cakebase/tree/master/examples)
### **Getting started**
Use [npm](https://www.npmjs.com/) or [yarn](https://classic.yarnpkg.com/en/) to install cakebase.
```bash
npm i cakebase
```
After the installation you can create a json file and start immediately.
### **Usage**
Now you can import Cakebase to your project.
This is the easiest way to use Cakebase
```javascript
const users = require('cakebase')("./users.json");
```
You can also use Cakebase with multiple json files
```javascript
const table = require('cakebase');
const users = table("./users.json");
const log = table("./log.json");
```
add an object to the json file
```javascript
await users.set({ id: 0, username: "John", email: "test@something.com" });
```
Retrieve for objects in the json file
```javascript
const user = await users.get(obj => obj.username === "John");
```
update objects in the json file
```javascript
await users.update(obj => obj.username === "John", { location: "Mars" });
```
remove objects in the json file
```javascript
await users.remove(obj => obj.location === "earth");
```
Delete all objects in the json file
```javascript
await users.clear();
```
### **Contributing**
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
### **License**
[MIT](https://github.com/erwinkulasic/Cakebase/blob/master/LICENSE)