UniKVS

TypeScript 製のモジュラーな KVS クライアント UniKVS のドキュメントです。目的に合わせてチュートリアル、ハウツーガイド、解説、リファレンスを使い分けてください。

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

読み進め方

このドキュメントは Diátaxis の 4 分類に沿って構成しています。いまの目的に合う入口を選んでください。

クイックスタート

まずはメモリーストレージで最小構成を試します。所要時間は 5 分程度です。

import { Memory } from "@unikvs/memory";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{
  greeting: unikvs.PlainValue<string>;
}>()
  .persist(new Memory())
  .build();

await kvs.open();
await kvs.set("greeting", "hello");

const value = await kvs.get("greeting");
console.log(value); // "hello"

await kvs.close();

詳しい手順ははじめての UniKVSで確認してください。

主な特徴

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

パッケージ

パッケージごとの使い方はパッケージリファレンスにまとめています。代表的なパッケージは次のとおりです。