# tessradb

> A local noSQL database

Latest version **1.7.3** (published 2022-02-06) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.3 |
| Published | 2022-02-06 |
| First published | 2022-01-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | artegoser |
| Maintainers | artegoser |
| Keywords | noSQL, DB, database, local, localdb, localdatabase |

## Links

- npm: https://www.npmjs.com/package/tessradb
- Repository: https://github.com/artegoser/TessraDB
- Homepage: https://github.com/artegoser/TessraDB#readme
- Issues: https://github.com/artegoser/TessraDB/issues
- npm.io page: https://npm.io/package/tessradb

## Dependencies (2)

- [JSONStream](https://npm.io/package/JSONStream.md) ^1.3.5
- [@types/node](https://npm.io/package/@types/node.md) ^17.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.7.3 (latest) — 2022-02-06
- 1.7.2 — 2022-02-06
- 1.7.1 — 2022-02-06
- 1.7.0 — 2022-01-11
- 1.6.0 — 2022-01-08
- 1.5.2 — 2022-01-06
- 1.5.1 — 2022-01-06
- 1.5.0 — 2022-01-06
- 1.4.0 — 2022-01-05
- 1.3.0 — 2022-01-05
- 1.2.0 — 2022-01-04
- 1.1.0 — 2022-01-04
- 1.0.2 — 2022-01-03
- 1.0.1 — 2022-01-03
- 1.0.0 — 2022-01-03
- … 3 more at https://npm.io/package/tessradb/versions

## README

<h1 align="center">
  <br>
    <a href="https://artegoser.github.io/TessraDB/"><img src="https://artegoser.github.io/tessraStatic/tessradb.png" alt="Markdownify" width="200"></a>
  <br>
  TessraDB 
  <a href="https://twitter.com/intent/tweet?text=Get%20serverless%20JSON%20Database&url=https://github.com/artegoser/TessraDB&hashtags=typescript,database,serverless,nosql,db,embeddedDatabase,nosqlDatabase,jsonDatabase,tessradb"><img alt="Tweet me" src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"></a>
  <br>
</h1>

<h3 align="center">Local noSQL database for Node.js</h4>

<p align="center">
  <a href="https://www.npmjs.com/package/tessradb">
    <img alt="npm" src="https://img.shields.io/npm/v/tessradb">
  </a>
  <a href="https://app.travis-ci.com/github/artegoser/TessraDB">
    <img alt="Travis (.com)" src="https://img.shields.io/travis/com/artegoser/TessraDB">
  </a>
  <a href="https://coveralls.io/github/artegoser/TessraDB">
    <img alt="Coveralls" src="https://img.shields.io/coveralls/github/artegoser/TessraDB">
  </a>
</p>

<p align="center">
  <a href="https://www.reddit.com/r/tessradb/"><img alt="Subreddit subscribers" src="https://img.shields.io/reddit/subreddit-subscribers/TessraDB?style=social"></a>
</p>

<p align="center">
  <a href="#features">Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#roadmap">Roadmap</a> •
  <a href="#contributing">Contributing</a> •
  <a href="#credits">Credits</a> •
  <a href="#license">License</a>
</p>

<p align="center">
  <a align="center" href="https://artegoser.github.io/TessraDB/">Documentation</a>
</p>

## Features

- Low memory consumption and fast work due to streaming reading and writing.
- Smart filter for extracting data from collections.
- Atomic write, your data will not be corrupted.

## How To Use

### Installation

- #### NPM
  ```bash
  npm i tessradb
  ```
- #### YARN
  ```bash
  yarn add tessradb
  ```

### Usage

- ### Import

  ```js
  let { TessraDB } = require("tessradb");
  //or
  import { TessraDB } from "tessradb";
  ```

- ### First DataBase

  ```js
  import { TessraDB } from "tessradb";
  let db = new TessraDB("first"); //create a db with name "first"
  run(db);

  async function run(db) {
    let firstCol = await db.getCollection("firstCollection");
    await firstCol.insertMany([
      { type: "man", age: 1, height: 56 },
      { type: "woman", age: 2, height: 76 },
    ]); //insert documents to collection
    console.log(await firstCol.findOne({ type: "man" }));
    //find one document with type "man"
    //output: { type: "man", age: 1, height: 56 }
  }
  ```

## Roadmap

[TODO list](https://github.com/artegoser/TessraDB/blob/main/.github/todo.md)  
You can also suggest new features in [issues](https://github.com/artegoser/TessraDB/issues) yourself.

## Contributing

![Our contributors](https://badges.pufler.dev/contributors/artegoser/tessradb?size=50&padding=2&bots=false)

Your contributions are always welcome! Please look at the [contribution guidelines](https://github.com/artegoser/TessraDB/blob/main/.github/CONTRIBUTING.md) first. 🎉

## Credits

TessraDB uses:

- [JSONStream](https://www.npmjs.com/package/JSONStream) for stream reading and writing JSON

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/artegoser/TessraDB/blob/main/LICENSE)  
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fartegoser%2FTessraDB.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fartegoser%2FTessraDB?ref=badge_large)

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