# @enrayned/db

> Database package

Latest version **1.0.2** (published 2024-02-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @enrayned/db
pnpm add @enrayned/db
yarn add @enrayned/db
bun add @enrayned/db
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2024-02-04 |
| First published | 2024-02-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 41.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | senesatka |
| Maintainers | iseray, senesatka |

## Links

- npm: https://www.npmjs.com/package/@enrayned/db
- npm.io page: https://npm.io/package/@enrayned/db

## Dependencies (3)

- [yaml](https://npm.io/package/yaml.md) ^2.3.4
- [bson-ext](https://npm.io/package/bson-ext.md) ^4.0.3
- [@chocolatemilkdev/emitter](https://npm.io/package/@chocolatemilkdev/emitter.md) ^1.0.6

## Recent versions

- 1.0.2 (latest) — 2024-02-04
- 1.0.1 — 2024-02-04
- 1.0.0 — 2024-02-04

## README

## Imports

```js
import { Db } from "@enrayned/db";
// or
const { Db } = require("@enrayned/db");
```

## Usage

```js
const dbOptions = {
  path: string, //default enrayned
  file: string, //default database
  type: "json" | "bson" | "yaml", //default json
};
const db = new Db(dbOptions);
db.set("users.111", { name: "SeneSatka", id: "111" });
/**
{"users":{"111":{"name":"SeneSatka","id":"111"}}}
 */
db.push("users.111.inventory", { name: "Sword", damage: 10, level: 1 });
/**....
"inventory":[{ name: "Sword", damage: 10, level: 1 }]
....*/
db.push("users.111.inventory", { name: "bow", damage: 20, level: 4 });
/**....
"inventory":[
{ name: "Sword", damage: 10, level: 1 },
{ name: "bow", damage: 20, level: 4 }
]
....*/
db.pull("users.111.inventory", { name: "Sword", damage: 10, level: 1 });
/**....
"inventory":[
{ name: "bow", damage: 20, level: 4 }
]
....*/
db.delete("users.111.inventory");

db.all();
// [ { id: 'users', data: { '111':{"name":"SeneSatka","id":"111" }}} ]
db.deleteAll();
```

## Emitter

```js
/** database.json
 {
    "name":"SeneSatka"
 }
 */
db.on("set", (data) => {
  console.log(data);
});
db.set("name", "Testt");
/** set listener output
 { key: 'name', oldValue: 'SeneSatka', newValue: 'Testt' }
  */
```

---
_Source: https://npm.io/package/@enrayned/db · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._