# kotchill.db

> Database with better-sqlite3

Latest version **0.0.5** (published 2022-03-08) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2022-03-08 |
| First published | 2022-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 32.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | IboHub |
| Maintainers | ibohub |
| Keywords | database, storing, values, easy, quick, sqlite, sqlite3, db |

## Links

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

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.17.20
- [better-sqlite3](https://npm.io/package/better-sqlite3.md) ^7.1.1

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

- 0.0.5 (latest) — 2022-03-08
- 0.0.4 — 2022-03-08
- 0.0.3 — 2022-03-08
- 0.0.2 — 2022-03-08
- 0.0.1 — 2022-03-08

## README

## kotchill.db

**NPM:** [npmjs.com/kotchill.db](https://www.npmjs.com/package/kotchill.db)

- **Persistent Storage** - Data doesn't disappear through restarts
- **Works out of the box** - No need to set up a database server, all the data is stored locally in the same project
- **Beginner Friendly** - Originally created for use in tutorials, the documentation is straightforward and jargon-free
- & more...

## Example

```js
const db = require('kotchill.db');

db.set('userInfo', { difficulty: 'Easy' })
// { difficulty: 'Easy' }

db.push('userInfo.items', 'Sword')
//{ difficulty: 'Easy', items: ['Sword'] }

db.add('userInfo.balance', 500)
//{ difficulty: 'Easy', items: ['Sword'], balance: 500 }

db.push('userInfo.items', 'Watch')
//{ difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 500 }
db.add('userInfo.balance', 500)
//{ difficulty: 'Easy', items: ['Sword', 'Watch'], balance: 1000 }

db.get('userInfo.balance') // -> 1000
db.get('userInfo.items') // ['Sword', 'Watch']
```

## Installation

**Linux & Windows**
- `npm i kotchill.db`

***Note:** Windows users may need to do additional steps [listed here](https://github.com/JoshuaWise/better-sqlite3/blob/master/docs/troubleshooting.md).*

**Mac**
1. **Install:** XCode
2. **Run:** `npm i -g node-gyp` in terminal
3. **Run:** `node-gyp --python /path/to/python2.7` (skip this step if you didn't install python 3.x)
4. **Run:** `npm i kotchill.db`

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