# squark-storage

> A new form of database system

Latest version **2.4.2** (published 2020-06-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install squark-storage
pnpm add squark-storage
yarn add squark-storage
bun add squark-storage
```

## 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 | 2.4.2 |
| Published | 2020-06-07 |
| First published | 2020-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^12.18.0 |
| Dependencies | 0 |
| Unpacked size | 12.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Karel Matthieu |
| Maintainers | kmatthieu |
| Keywords | squark, database, storage |

## Links

- npm: https://www.npmjs.com/package/squark-storage
- Repository: https://github.com/kmatthieu14/SquarkStorage
- Homepage: https://github.com/kmatthieu14/SquarkStorage#readme
- Issues: https://github.com/kmatthieu14/SquarkStorage/issues
- npm.io page: https://npm.io/package/squark-storage

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 2.4.2 (latest) — 2020-06-07
- 2.3.1 — 2020-06-06
- 2.2.1-Indev — 2020-06-05
- 2.1.1 — 2020-06-05
- 2.1.0 — 2020-06-04
- 1.1.1 — 2020-06-04
- 1.1.0 — 2020-06-04
- 1.0.0 — 2020-06-03

## README

# SquarkStorage
A new form of database<br/>
![GitHub package.json version](https://img.shields.io/github/package-json/v/kmatthieu14/SquarkStorage)
![GitHub dependencies](https://img.shields.io/librariesio/github/kmatthieu14/SquarkStorage)
![GitHub repo size](https://img.shields.io/github/repo-size/kmatthieu14/SquarkStorage)

## Installation
```
npm i squark-storage --save
```

## Usage
Example
```js
const Squark = require("squark-storage");
const db = new Squark("My Database", {
  seed: 39275927,
  storage: ".data/database"
});

let User;

db.connect(() => {
  User = db.defineTable("user", {
    id: {
      type: Squark.UUID,
      autoGenerate: true
    }
    name: {
      type: Squark.STRING
    }
  });
});

User.insert({
  name: "KarelMatthieu"
});

console.log(User.search()); // Console: [{id: (UUID), name: "KarelMatthieu"}]
```
For changeLog click this link: [ChangeLog](https://github.com/kmatthieu14/SquarkStorage/blob/master/CHANGELOG.md) <br/>
Need more help? click this link: [Documentation](https://github.com/kmatthieu14/SquarkStorage/wiki/Documentation)

`Made by KarelMatthieu`

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