# aqualdb

> Simple DB for NodeJS using JSON

Latest version **1.3.2** (published 2023-09-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install aqualdb
pnpm add aqualdb
yarn add aqualdb
bun add aqualdb
```

## 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.3.2 |
| Published | 2023-09-10 |
| First published | 2023-06-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ironswordxdev |
| Maintainers | ironswordxdev |
| Keywords | db, database |

## Links

- npm: https://www.npmjs.com/package/aqualdb
- npm.io page: https://npm.io/package/aqualdb

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) ^18.0.6

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.3.2 (latest) — 2023-09-10
- 1.2.2 — 2023-09-10
- 1.2.1 — 2023-09-10
- 1.2.0 — 2023-09-10
- 1.1.0 — 2023-06-12
- 1.0.2 — 2023-06-11
- 1.0.1 — 2023-06-11
- 1.0.0 — 2023-06-11

## README

# AqualDB
## Simple DB for NodeJS using JSON
### Installing
#### Dependencies
```bash
npm i fs && npm inatall --save @types/node
```
#### Package
```bash
npm i aqualdb
```

<br><hr><br>
### Code
#### Import
```node
let importdb = require('aqualdb');
const db = new importdb();
```
AqualDB Defaults to a file called 'db.json' in the current active folder. This can
be changed by adding a string with a custom path to your file.
```node
let importdb = require('aqualdb');
const db = new importdb("/path-to-file/file.json");
```
And replace `path-to-file` with the path to the file (use `/` for the default
directory), and replace `file` with the name of your JSON file 
#### Scripts
AqualDB has a lot of different features. Here are the scripts that you
can use:
```node
db.exists(/* string to check if it eists as a key */)
```
This will return `true` if it does exist, and will return `false` if it does not exist.
```node
db.add(/* key name */, /* value (optional) */)
```
This will add a new key/value pair to the DB, with the key being the first argument and the value being the 2nd argument. (if the second argument is left blank, the value will just be `""`)
```node
db.delete(/* key name */)
```
This will delete a key/value pair that has the same key relative to the first argument
```node
db.list(/* prefix (optional) */)
```
This will return an array of all the keys. If a prefix is specified, only keys with that prefix will be included.
```node
db.get(/* key */)
```
This will return the value of a key with the name of the first argument
```node
db.set(/* key */, /* value */)
```
This will change of the value of a key (first argument) with a value (second argument)
```node
db.count()
```
This will return the number of keys

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