# @jimber/pkid

> Lightweight node client for pkid

Latest version **1.0.5** (published 2022-08-30) · ISC license · 0 weekly downloads

## Install

```sh
npm install @jimber/pkid
pnpm add @jimber/pkid
yarn add @jimber/pkid
bun add @jimber/pkid
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-08-30 |
| First published | 2019-08-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 71.9 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jimber |
| Maintainers | singlecore, deanverjans, tobiaschielensjimber |
| Keywords | pkid, client, node |

## Links

- npm: https://www.npmjs.com/package/@jimber/pkid
- Repository: https://github.com/JimberSoftware/pkid-node-client
- Homepage: https://github.com/JimberSoftware/pkid-node-client#readme
- Issues: https://github.com/JimberSoftware/pkid-node-client/issues
- npm.io page: https://npm.io/package/@jimber/pkid

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [tweetnacl](https://npm.io/package/tweetnacl.md) ^1.0.1
- [tweetnacl-util](https://npm.io/package/tweetnacl-util.md) ^0.15.0
- [libsodium-wrappers](https://npm.io/package/libsodium-wrappers.md) ^0.7.6

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2022-08-30
- 1.0.4 — 2020-01-22
- 1.0.2 — 2019-08-29
- 1.0.1 — 2019-08-29

## README

# PKID

## Concept
PKID is a public Key Indexed Datastore. You can save plain or encrypted data in a public key index; as long as you are the owner of the secret corresponding to that public key.

# install

```
npm install @jimber/pkid
```

# initialize

```
const pkid = require('pkid')
const client = new pkid(url, publicKey, privateKey)
```

# Routes

## Document storage
### Set document

```
client.setDoc(key, document)
```

Set the value of a document corresponding to {key} indexed by the public key {pk}.


### Get document

```
client.getDoc(pk, key)
```

Get the value of a document corresponding to {key} indexed by the public key {pk}. There is no requirement for a security header

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