# ubase-db

> µBase - A simple NodeJS database for experiments and prototypes.

Latest version **1.0.0** (published 2018-02-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install ubase-db
pnpm add ubase-db
yarn add ubase-db
bun add ubase-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.0.0 |
| Published | 2018-02-06 |
| First published | 2018-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ethan McTague |
| Maintainers | emctague |
| Keywords | database, json, wrapper, library |

## Links

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

## 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.0.0 (latest) — 2018-02-06

## README

# µBase

µBase is a simple NodeJS database intended specifically for small projects, prototypes, and anything that will
never end up in production. If you don't have time to install and struggle with a complicated database, this is
the tool for you.

It is essentially a wrapper atop a JSON file, adding autosave/load, a basic document-esque structure, and
some helpers for filtering and manipulating lists of entries.

**Use this for experiments. DO NOT use it for large-scale projects.**

## Features:
 - Local JSON file-based storage.
 - Multiple tables of data.
 - Automatic saving.
 - Pure JSON object structure.
 - Simple functions for filtering, adding, removing, updating, etc.

## Simple Usage (just read the source code comments for more methods):

```js
// Load our database.
const db = await ub("hello.json")

// Get the "messages" document listing.
const messages = db("messages")

// Find the first message with the name field value "Delete the First of Me" and remove it.
messages.filter({ name: "Delete the First of Me" }).limit(1).remove()
```

## License

Copyright &copy; 2018 Ethan McTague.

Licensed under the MIT license. See LICENSE for more details.

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