# @amnesia-js/core

> Javascript Client for AmnesiaDB

Latest version **1.2.3** (published 2021-09-17) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @amnesia-js/core
pnpm add @amnesia-js/core
yarn add @amnesia-js/core
bun add @amnesia-js/core
```

## 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.2.3 |
| Published | 2021-09-17 |
| First published | 2021-09-15 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 54 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nikhil Nayak |
| Maintainers | nikhilcodes |
| Keywords | amnesia-db, amnesia, amnesia-js |

## Links

- npm: https://www.npmjs.com/package/@amnesia-js/core
- Repository: https://github.com/NikhilCodes/amnesia-js
- Homepage: https://github.com/NikhilCodes/amnesia-js#readme
- Issues: https://github.com/NikhilCodes/amnesia-js/issues
- npm.io page: https://npm.io/package/@amnesia-js/core

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2

## Recent versions

- 1.2.3 (latest) — 2021-09-17
- 1.2.2 — 2021-09-16
- 1.2.1 — 2021-09-16
- 1.2.0 — 2021-09-16
- 1.0.0 — 2021-09-15

## README

# Amnesia JS
[AmnesiaDB](https://github.com/NikhilCodes/AmnesiaDB) Official Client

## Example

Connect to locally hosted Amnesia DB
```javascript
import { AmnesiaClient } from 'amnesia-client';

const am = new AmnesiaClient();
await am.connect({ port: 4224 });
```

Run a Query
```javascript
let res = await am.query('SET a AS b WHERE TTL=10s NFETCH=2');
console.log(res) // OK
```

Alternatively
```javascript
let res = await am.get('key');  // null
await am.set('key', 'value', { ttl: '20s', nfetch: 2 });
let res = await am.get('key');  // value
```

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