# furfy.db

> Basic json database module.

Latest version **1.1.0** (published 2023-03-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install furfy.db
pnpm add furfy.db
yarn add furfy.db
bun add furfy.db
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2023-03-10 |
| First published | 2023-03-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | https://github.com/vsl-dev |
| Maintainers | vsl.dev |
| Keywords | Furfy.db, Database, Json, JsonDb, Db, db |

## Links

- npm: https://www.npmjs.com/package/furfy.db
- Repository: https://github.com/vsl-dev/furfy.db
- Homepage: https://github.com/vsl-dev/furfy.db#readme
- Issues: https://github.com/vsl-dev/furfy.db/issues
- npm.io page: https://npm.io/package/furfy.db

## Dependencies (3)

- [fs](https://npm.io/package/fs.md) ^0.0.1-security
- [bytes](https://npm.io/package/bytes.md) ^3.1.2
- [cli-color](https://npm.io/package/cli-color.md) ^2.0.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-03-10
- 1.0.1 — 2023-03-08
- 1.0.0 — 2023-03-08

## README

# =========< FURFY DB >=========

## Basic JSON Database Module

### Changelogs: v1.1.0

- Added .getValues() and .getKeys() functions
- Fixed some bugs

### Installing

```shell
$ npm i furfy.db
```

### Setup

- Common JS

```js
const { Database } = require("furfy.db");
```

- ES Modules (ESM)

```js
import { Database } from "furfy.db";
```

```js
const db = new Database("./database.json", {
  name: "Database", // Database name
});
```

#

### Usage

```js
// Adding methods

db.set("test", { data: "test" }); // { "test": "test" }
db.push("pushTest", { data: "test" }); // { "pushTest": [ "test" ] }
db.add("counter", 1); // { "counter": 1 }

// Fetching methods

db.get("counter"); // { "counter": 1 }
db.fetch("test"); // { "test": "test" }
db.has("test"); // true or false
db.fetchAll(); // { "test": "test", "pushTest": [ "test" ], "counter": 1 }
db.getValues("testers"); // from { "testers": "tester1": true, "tester2": false } to [ { "tester1": true } , { "tester2": false } ]
db.getKeys("testers"); // [ "tester1", "tester2" ]

// Deleting methods

db.delete("test");

// Information methods

db.size(); // 47B
db.info(); // { "name": "Database", "path": "./databases/database.json", "size": "47B" }

// Others

db.clear(); // Clear all databases
```

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