インストール

実行環境に合わせて UniKVS とプラグインを導入する手順です。

目的の保存先と変換処理に合わせて、必要なパッケージだけを導入します。

本体を導入する

unikvs は必須です。保存先や変換処理は別パッケージとして導入します。

npm install unikvs

pnpm add unikvs

yarn add unikvs

bun add unikvs

nub add unikvs

aube add unikvs

使う保存先のパッケージを追加します。代表的な組み合わせは次のとおりです。

テストや一時的な保存に使います。追加の外部サービスは不要です。

npm install @unikvs/memory

pnpm add @unikvs/memory

yarn add @unikvs/memory

bun add @unikvs/memory

nub add @unikvs/memory

aube add @unikvs/memory

Node.js のローカルファイルシステムに保存します。

npm install @unikvs/fs.node

pnpm add @unikvs/fs.node

yarn add @unikvs/fs.node

bun add @unikvs/fs.node

nub add @unikvs/fs.node

aube add @unikvs/fs.node

ブラウザーでは OPFS、IndexedDB、Local Storage などから選びます。

npm install @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

pnpm add @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

yarn add @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

bun add @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

nub add @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

aube add @unikvs/opfs @unikvs/indexeddb @unikvs/localstorage

保存先の選び方はストレージ比較を参照してください。各パッケージの詳細はパッケージリファレンスを参照してください。

値の変換が必要な場合だけ、使うミドルウェアを追加します。

npm install @unikvs/json @unikvs/compression

pnpm add @unikvs/json @unikvs/compression

yarn add @unikvs/json @unikvs/compression

bun add @unikvs/json @unikvs/compression

nub add @unikvs/json @unikvs/compression

aube add @unikvs/json @unikvs/compression

Valibot スキーマで入出力値を検証する場合は、valibot を別途導入します。

npm install valibot

pnpm add valibot

yarn add valibot

bun add valibot

nub add valibot

aube add valibot

Builder の schema オプションにスキーマを渡すと検証が有効になります。詳しい手順は値を検証するを参照してください。