homedb/README.md

Better local storage.

# HomeDB

[![homedb on npm](https://img.shields.io/npm/v/homedb.svg)](https://www.npmjs.com/package/homedb)

## Installation

```bash
npm install homedb
```

### Example
```js
const homeDB = require("homedb");
const db = new homeDB();

// Or specify a custom path:
// const db = new homeDB({ path: "path/to/data.db" });

// Store an array
db.set("levels", [{ level: 1 }, { level: 2 }]);
console.log(db.get("levels"));
// Output: [{ level: 1 }, { level: 2 }]

// Add an item
db.push("levels", { level: 3 });
console.log(db.get("levels"));
// Output: [{ level: 1 }, { level: 2 }, { level: 3 }]

// Filter items
const level1 = db.pull("levels", e => e.level === 1);
console.log(level1);
// Output: [{ level: 1 }]

// Get all data
console.log(db.getAll());
// Output: [{ id: 'levels', data: [{ level: 1 }, { level: 2 }, { level: 3 }] }]

// Remove certain items
db.pullDelete("levels", e => e.level === 2);
console.log(db.get("levels"));
// Output: [{ level: 1 }, { level: 3 }]

// Delete a key
db.delete("levels");
console.log(db.get("levels"));
// Output: undefined

// Work with numbers
db.set("user_points", 10);
console.log(db.get("user_points"));
// Output: 10

db.add("user_points", 5);
console.log(db.get("user_points"));
// Output: 15

db.subtract("user_points", 7);
console.log(db.get("user_points"));
// Output: 8

// Delete all data
db.deleteAll();
console.log(db.getAll());
// Output: {}
```