はじめての UniKVS

メモリーストレージを使って UniKVS の保存と読み戻しを試す手順です。

このチュートリアルでは、メモリーストレージを使って値の保存と読み戻しを行います。所要時間は 10 分程度です。細かい仕組みは後回しにして、まず動くものを作ります。

完成物のイメージ

この手順を終えると、次のことができるようになります。

Builder でクライアントを組み立てます。
open() で初期化し、set() と get() で読み書きします。
close() で後片づけをします。

前提条件

Node.js が使える環境を用意します。
TypeScript のプロジェクトを用意します。

手順

パッケージをインストールする

unikvs と @unikvs/memory をインストールします。

npm install unikvs @unikvs/memory

pnpm add unikvs @unikvs/memory

yarn add unikvs @unikvs/memory

bun add unikvs @unikvs/memory

nub add unikvs @unikvs/memory

aube add unikvs @unikvs/memory

クライアントを組み立てる

Builder にメモリーストレージを渡し、クライアントを作ります。ここではキー greeting に文字列を保存します。

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

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

保存して読み戻す

open() で初期化してから、set() と get() を実行します。使い終わったら close() で閉じます。

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

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

await kvs.close();

振り返り

今回の構成は次のとおりです。

persist() で保存先を登録します。
build() でクライアントを作ります。
読み書きの前には open() が必要です。

次のステップ

インストール

実行環境に合わせた導入手順を確認します。

アーキテクチャー

書き込みと読み取りの流れを理解します。

値のモデル

単一値とストリームの使い分けを確認します。

ストレージ比較

メモリー以外の保存先を選びます。