@unikvs/cache-storage

@unikvs/cache-storage の CacheStorage。Cache API に Response を保存するストレージの使い方を説明します。

概要

@unikvs/cache-storage ブラウザー専用は Cache API に Response を保存するストレージです。取得した応答をそのまま蓄えたい場合に使います。

name は CacheStorage です。
open・close が必要です。open は Cache を開きます。
論理キーから Request への変換は toRequest で指定します。
専用の Cache を使うので、clear は列挙した要求をすべて削除します。

インストールは次のコマンドで行います。

npm install @unikvs/cache-storage

pnpm add @unikvs/cache-storage

yarn add @unikvs/cache-storage

bun add @unikvs/cache-storage

nub add @unikvs/cache-storage

aube add @unikvs/cache-storage

使い方

CacheStorage は IStorage を実装しています。UniKvs には persist() で渡します。

import { CacheStorage } from "@unikvs/cache-storage";

コンストラクターの引数は次のとおりです。

プロパティ型

cacheNamestring

使う Cache の名前です。

型string

toRequestIToRequest

論理キーを Request に変換する関数です。

型IToRequest

caches?CacheStorage | undefined

使う Cache API の CacheStorage です。省略した場合は実行環境の Cache API を使います。

型CacheStorage | undefined

以下は、Response を保存して読み戻す例です。

import { CacheStorage } from "@unikvs/cache-storage";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{
  page: unikvs.PlainValue<Response>;
}>()
  .persist(
    new CacheStorage({
      cacheName: "unikvs",
      toRequest: (key) => `/kvs/${key}`,
    }),
  )
  .build();

await kvs.open();
await kvs.set("page", new Response("hello"));

const res = await kvs.get("page");
console.log(await res.text()); // "hello"

await kvs.close();

データ型

操作	対応するデータ型
`write`・`read`	`Response`
`getWritable`・`getReadable` のチャンク	`Uint8Array<ArrayBuffer>`

Response をそのまま保存します。
ストリームのチャンクは Uint8Array<ArrayBuffer> のみに対応します。
getWritable で取得したストリームは、チャンクを結合し、close 時に Response として保存します。
getReadable で取得したストリームは、保存した Response のバイト列を単一チャンクとして送出します。

エラー

このパッケージが投げるエラーは次のとおりです。

KeyNotFoundError

意味

指定したキーが存在しない場合に投げます。@unikvs/core の共通エラーです。

対処方法

exists で確認してから読み出してください。

例

以下は、KeyNotFoundError を捕捉する例です。

import { KeyNotFoundError } from "@unikvs/cache-storage";

try {
  await kvs.get("missing-key");
} catch (ex) {
  if (ex instanceof KeyNotFoundError) {
    console.log("キーが見つかりません");
  } else {
    throw ex;
  }
}