Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reseau-constellation/orbit-db-kuiper
Extra components for orbit-db
https://github.com/reseau-constellation/orbit-db-kuiper
Last synced: about 1 month ago
JSON representation
Extra components for orbit-db
- Host: GitHub
- URL: https://github.com/reseau-constellation/orbit-db-kuiper
- Owner: reseau-constellation
- License: agpl-3.0
- Archived: true
- Created: 2023-09-30T11:44:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-26T13:08:50.000Z (10 months ago)
- Last Synced: 2024-08-29T21:39:14.919Z (4 months ago)
- Language: TypeScript
- Size: 154 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kuiper
Additional database types for orbit-db.
[](https://github.com/reseau-constellation/orbit-db-kuiper/actions/workflows/tests.yml)
[](https://codecov.io/gh/reseau-constellation/orbit-db-kuiper)
## Deprecation notice
This package is deprecated in favour of the individual packages [@orbitdb/feed-db](https://www.npmjs.com/package/@orbitdb/feed-db), [@orbitdb/set-db](https://www.npmjs.com/package/@orbitdb/set-db) and [@orbitdb/ordered-keyvalue-db](https://www.npmjs.com/package/@orbitdb/ordered-keyvalue-db).
## Installation
```
$ pnpm add @constl/orbit-db-kuiper
```
## Introduction
`Kuiper` brings additional database types to `orbit-db`.
* `Feed`: For those feeling nostalgic for orbit-db v.0.x. But honestly, you're probably better off with a `KeyValue` or a `Set`.
* `Set`: Like `Feed`, but each value can only be present once. Works for primitive types as well as more complex objects.
* `OrderedKeyValue`: A `KeyValue` database where you can move entries around. Ideal for situations where order is important (e.g., lists of tabs in a spreadsheet, etc.).
## Examples
### Set
As simple example with `Set`:
```ts
import { createOrbit } from "@orbitdb/core";
import { registerAll } from "@constl/orbit-db-kuiper";
// Register Kuiper database types. IMPORTANT - must call before creating orbit instance !
registerAll();
const orbit = await createOrbit({ ipfs })
const db = await orbit.open({ type: "set" });
await db.add(1);
await db.add(2);
const all = await db.all(); // [1, 2]
await db.add(1);
await db.all() // Yay !! Still [1, 2]
```
### Feed
```ts
const db = await orbit.open({ type: "feed" });
await db.add({ a: 1, b: "c" });
const all = await db.all(); // [{ value: { a: 1, b: "c" }, hash: "..." }]
await db.add({ a: 1, b: "c" });
await db.all();
// [{ value: { a: 1, b: "c" }, hash: "..." }, { value: { a: 1, b: "c" }, hash: "..." }]
```
### OrderedKeyValue
```ts
const db = await orbit.open({ type: "ordered-keyvalue" });
await db.put("a", "some value");
await db.put("b", "another value");
const all = await db.all();
// [{ key: "a", value: "some value", hash: "..." }, { key: "b", value: "another value", hash: "..." }]
await db.move("a", 1)
await db.all();
// [{ key: "b", value: "another value", hash: "..." }, { key: "a", value: "some value", hash: "..." }]
// You can also specify the position on `put`
await db.put("c", "goes first", 0);
await db.all();
// [{ key: "c", value: "goes first", hash: "..." }, { key: "b", value: "another value", hash: "..." }, { key: "a", value: "some value", hash: "..." }]
```