# wynddb

> Super simple async JSON based Database that saves to a file.

Latest version **2.0.2** (published 2021-11-11) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2021-11-11 |
| First published | 2021-10-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | WyndXP |
| Maintainers | wyndxp |
| Keywords | db, easy, wynd, database |

## Links

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

## 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

- 2.0.2 (latest) — 2021-11-11
- 1.0.0 — 2021-10-22

## README

## WyndDB
Are you tired of all those complex database systems like SQL and MongoDB that all have confusing syntax? Do you want a simple DB that is easy to use, yet powerful for small projects? Then this no-dependency library is the solution for you! It uses filesystem to write & read JSON to a file called `wdb`, and puts all data into separate modules with user specified names.

This too complex? Here's an example of WyndDB in use:
```js
//Import the module's Connector class
import { Connector } from "wynddb";

//Create or Access the db
let connection = new Connector({
		name: 'users',
		file: './users.json'
}).then(async db => {
	await db.set('user1', {
		id: 1,
		name: 'test_user',
		verified: false
	});
	await db.update('user1', { verified: true });
	await db.get('user1') // returns { id: 1, name: "test_user", verified: true }
});
```
### Documentation:
classes: `Connector` - The database connection object (doesn't hold the data)

`<Connector>.connect(name)` - Connect/create a db

`<Connector>.get(key)` - If there is a key, it will return the keys value, if not, it will return the db.

`<Connector>.set(key, value)` - add a key value pair to the db

`<Connector>.delete(key)` - If there is a key, it will delete the keys value, if not, it will delete the db.

`<Connector>.filter(filter function)` - filter stuff from a db

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