# leveldb-tcp-server

> A redis compatible protocal levelDB tcp server

Latest version **1.0.1** (published 2020-07-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install leveldb-tcp-server
pnpm add leveldb-tcp-server
yarn add leveldb-tcp-server
bun add leveldb-tcp-server
```

## 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.1 |
| Published | 2020-07-31 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | b9891052@ntu.edu.tw |
| Maintainers | homuchen |
| Keywords | leveldb, tcp, database, redis-protocal, redis |

## Links

- npm: https://www.npmjs.com/package/leveldb-tcp-server
- Repository: https://github.com/HoMuChen/leveldb-tcp-server
- Homepage: https://github.com/HoMuChen/leveldb-tcp-server#readme
- Issues: https://github.com/HoMuChen/leveldb-tcp-server/issues
- npm.io page: https://npm.io/package/leveldb-tcp-server

## Dependencies (2)

- [level](https://npm.io/package/level.md) ^6.0.1
- [redis-parser](https://npm.io/package/redis-parser.md) ^3.0.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-07-31
- 1.0.0 — 2020-04-30

## README

# leveldb-tcp-server

A redis compatible protocal levelDB tcp server

## Usage

    $ npm install leveldb-tcp-server

```javascript
const Server = require('leveldb-tcp-server');

const server = new Server({
  port: 2407,
  dbPath: './test'
})

server.run();

```

or 

    $ git clone https://github.com/HoMuChen/leveldb-tcp-server.git
    $ cd leveldb-tcp-server
    $ npm run start

this script will default run a server listening on port <b>2407</b> and create a directory <b>test</b> for the leveldb data.

## Client access

Application protocal is compatible with redis protocal, so we can use redis client library to access db.

```javascript
const redis = require('redis')

const client = redis.createClient({ port: 2407 });

client.set("key", "123", (err, result) => {
  client.get("key", (err, result) => {
    console.log(result)
  });
});
```

For now, I only implement the <b>get</b>, <b>set</b> and <b>del</b> command.

## Author

HoMuchen - b98901052@ntu.edu.tw

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