# @liskhq/lisk-db

> A database access implementation according to the Lisk protocol

Latest version **0.3.10** (published 2023-09-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @liskhq/lisk-db
pnpm add @liskhq/lisk-db
yarn add @liskhq/lisk-db
bun add @liskhq/lisk-db
```

## Health

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

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

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.10 |
| Published | 2023-09-21 |
| First published | 2020-12-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.13.0 |
| Dependencies | 4 |
| Unpacked size | 453.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 2 |
| Author | Lisk Foundation |
| Maintainers | ishantiw, shuse2, juanglisk |
| Keywords | lisk, blockchain |

## Links

- npm: https://www.npmjs.com/package/@liskhq/lisk-db
- Repository: https://github.com/LiskHQ/lisk-db
- Homepage: https://github.com/LiskHQ/lisk-db/tree/main#readme
- Issues: https://github.com/LiskHQ/lisk-db/issues
- npm.io page: https://npm.io/package/@liskhq/lisk-db

## Dependencies (4)

- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [@types/node](https://npm.io/package/@types/node.md) ^16 || ^18
- [cargo-cp-artifact](https://npm.io/package/cargo-cp-artifact.md) ^0.1
- [@mapbox/node-pre-gyp](https://npm.io/package/@mapbox/node-pre-gyp.md) ^1.0.9

## Recent versions

- 0.3.10 (latest) — 2023-09-21
- 0.3.9 — 2023-09-20
- 0.3.8 — 2023-09-05
- 0.3.7 — 2023-08-08
- 0.3.6 — 2023-05-30
- 0.3.5 — 2023-03-15
- 0.3.4 — 2023-02-06
- 0.3.3 — 2023-02-06
- 0.3.2 — 2022-12-31
- 0.3.1 — 2022-12-08
- 0.3.0 — 2022-12-08
- 0.2.1 — 2022-04-28
- 0.2.0 — 2021-05-21
- 0.1.0 — 2020-12-01

## README

# @liskhq/lisk-db

[![Build status](https://github.com/LiskHQ/lisk-db/actions/workflows/pr.yaml/badge.svg)](https://github.com/LiskHQ/lisk-db/actions/workflows/pr.yaml)
![npm](https://img.shields.io/npm/v/@liskhq/lisk-db)
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/liskHQ/lisk-db)
![GitHub repo size](https://img.shields.io/github/repo-size/liskhq/lisk-db)
[![DeepScan grade](https://deepscan.io/api/teams/6759/projects/25497/branches/799572/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=6759&pid=25497&bid=799572)
![GitHub issues](https://img.shields.io/github/issues-raw/liskhq/lisk-db)
![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/liskhq/lisk-db)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

@liskhq/lisk-db is a database access implementation according to the Lisk protocol

## Installation

```sh
$ npm install --save @liskhq/lisk-db
```

## Get Started
```js
const { Database } = require('@liskhq/lisk-db');
const db = new Database('./new-database');

await db.set(Buffer.from([0]), Buffer.from('new item'));
const value = await db.get(Buffer.from([0]));
console.log(value);
```

## Dependencies
The following dependencies need to be installed in order to build this repository.

* [Node.js v18](https://nodejs.org)
* [Rust](https://www.rust-lang.org/)

## License

Copyright 2016-2023 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[lisk core github]: https://github.com/LiskHQ/lisk
[lisk documentation site]: https://lisk.com/documentation/lisk-sdk/references/lisk-elements/db.html

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