UniKVS

TypeScript 製のモジュラーな KVS クライアント UniKVS の概要とドキュメント案内です。

UniKVSとは

UniKVS は TypeScript 製のモジュラーでポータブルな KVS クライアントです。透過的にデータを変換するトランスフォーマーと、複数バックエンドに書き込むストレージを、ビルダーパターンで組み合わせます。

主な特徴は次のとおりです。

• トランスフォーマーによる透過的なエンコード・デコードに対応します。
• 複数のストレージへの並列書き込みに対応します。
• キーごとに値の型を定義し、利用可能な操作を型レベルで制御します。
• Valibot スキーマによる入出力値の実行時検証に対応します。
• 単一値とストリームの両方に対応します。
• AbortSignal によるキャンセルと実行時変数の受け渡しに対応します。
• Node.js とブラウザーの両方に対応したストレージを用意しています。

クイックスタート

npm install unikvs @unikvs/compression @unikvs/fs.node

pnpm add unikvs @unikvs/compression @unikvs/fs.node

yarn add unikvs @unikvs/compression @unikvs/fs.node

bun add unikvs @unikvs/compression @unikvs/fs.node

nub add unikvs @unikvs/compression @unikvs/fs.node

aube add unikvs @unikvs/compression @unikvs/fs.node

import { Compression } from "@unikvs/compression";
import { NodeFs } from "@unikvs/fs.node";
import { UniKvs, type Value } from "unikvs";

const kvs = UniKvs.config<{
  foo: Value<Uint8Array<ArrayBuffer>>;
}>()
  .appendTransformer(new Compression("gzip"))
  .appendStorage(new NodeFs(".tmp"))
  .create();

await kvs.open();

await kvs.set("foo", Uint8Array.from([0, 1, 2]));

const bytes = await kvs.get("foo");

await kvs.close();

上記の例では、キー foo のバイト列を透過的に gzip 圧縮し、.tmp/ 配下に保存します。

ドキュメントの読み進め方

パッケージ一覧

動作環境