パッケージリファレンス
UniKVS のパッケージの一覧と案内です。
UniKVS は本体パッケージと、プラグインと補助のパッケージから構成されます。本体の unikvs 以外は、目的に合わせてインストールします。
インストール方法はインストールを、保存先の選び方はストレージ比較を参照してください。
本体
共有
すべてのパッケージで共有される基盤です。
@unikvs/core
全パッケージで共有する型とエラーの基盤です。
@unikvs/utils
プラグイン実装者向けの共有関数群です。
@unikvs/testing
プラグインのテスト用コンテキストとヘルパーです。
ストレージ
データの保存先を提供します。動作環境ごとに分かれています。
@unikvs/memory
メモリー上に任意のデータを保存します。
@unikvs/http
HTTP サーバーを保存先として扱います。
@unikvs/null
何も保存しない送り先として使います。
@unikvs/lru-cache
件数や容量の上限付きでデータをメモリーに保存します。
@unikvs/opfs
ブラウザーの OPFS に保存します。
@unikvs/indexeddb
ブラウザーの IndexedDB に保存します。
@unikvs/localstorage
ブラウザーの Local Storage に保存します。
@unikvs/session-storage
ブラウザーの sessionStorage に文字列を保存します。
@unikvs/fs.node
Node.js のローカルファイルシステムに保存します。
@unikvs/s3.node
S3 互換のオブジェクトストレージに保存します。
@unikvs/redis.node
Redis に保存します。
@unikvs/fs.bun
Bun のローカルファイルシステムに保存します。
@unikvs/s3.bun
Bun で S3 互換のオブジェクトストレージに保存します。
@unikvs/redis.bun
Bun の Redis クライアントを使って Redis に保存します。
@unikvs/valkey
Valkey に保存します。
@unikvs/memcached
Memcached に保存します。
@unikvs/etcd
etcd に保存します。
@unikvs/cache-storage
ブラウザーの Cache Storage に保存します。
@unikvs/cookies
Cookie を保存先として扱います。
@unikvs/cloudflare-kv
Cloudflare KV に保存します。
@unikvs/cloudflare-r2
Cloudflare R2 に保存します。
@unikvs/cloudflare-cache
Cloudflare Cache API に保存します。
@unikvs/vercel-blob
Vercel Blob に保存します。
@unikvs/vercel-runtime-cache
Vercel ランタイムのキャッシュに保存します。
@unikvs/retry
一時的な失敗を再試行するラッパーです。
@unikvs/soft-delete
削除操作を論理削除として扱うラッパーです。
ミドルウェア
値を透過的に変換します。変換内容ごとに分かれています。
@unikvs/json
値を JSON に、ストリームでは JSON Lines に変換します。
@unikvs/superjson
Date・Map・Set・BigInt・undefined を保持したまま SuperJSON で変換します。
@unikvs/cbor
値を CBOR に、ストリームでは CBOR シーケンスに変換します。
@unikvs/v8-serde
Node.js の v8.serialize で値を高速にシリアライズします。
@unikvs/base64
バイト列を Base64 のテキストに変換します。
@unikvs/base64url
バイト列を URL セーフな Base64url に変換します。
@unikvs/hex
バイト列を 16 進数文字列 (Hex) に変換します。
@unikvs/compression
gzip・deflate・deflate-raw による圧縮と展開を行います。
@unikvs/checksum
MD5・SHA-1・SHA-224・SHA-256・SHA-384・SHA-512 の検証を行います。
@unikvs/zstd.wasm
WASM 版 zstd による圧縮と展開を行います。
@unikvs/zstd.node
Node.js の zstd による圧縮と展開を行います。
@unikvs/zstd.bun
Bun の zstd による圧縮と展開を行います。
@unikvs/brotli.node
Node.js の Brotli による圧縮と展開を行います。
@unikvs/brotli.bun
Bun の Brotli による圧縮と展開を行います。
@unikvs/brotli.wasm
WASM 版 Brotli による圧縮と展開を行います。
開発支援
挙動の観測と制御に寄るパッケージです。
@unikvs/debug
読み書きの操作とデータのデバッグ情報をログに記録します。
@unikvs/passthrough
データを何も変換せずそのまま透過させます。
@unikvs/tap
データを透過させながら、コンテキストを受け取るコールバックを実行します。
@unikvs/allow-repair
read-repair の書き戻しの可否を制御します。
@unikvs/key-prefix
すべてのキーに固定文字列を付与します。
@unikvs/writeonly
既存のストレージを書き込み専用にします。
@unikvs/readonly
既存のストレージを読み取り専用にします。
@unikvs/expiry
有効期限が付いた値が期限内かを検証します。
@unikvs/ttl
値に有効期限を付与して管理します。
@unikvs/rate-limit
操作の実行頻度を制限します。
@unikvs/metrics
操作のメトリクスを収集します。
@unikvs/tracing
操作のトレースを記録します。