@unikvs/readonly

書き込みを拒否して読み取り専用にする @unikvs/readonly の使い方を説明します。

概要

@unikvs/readonly Middleware は書き込みを拒否して読み取り専用にするミドルウェアです。

このミドルウェアは書き込み方向の操作 (set・copy・move・encode) を拒否し、読み取りはそのまま透過させます。allowDelete が false のときは削除も拒否します。

• name は ReadOnly です。
• isOpen は常に true です。
• allowDelete の既定値は false です。

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

npm install @unikvs/readonly

pnpm add @unikvs/readonly

yarn add @unikvs/readonly

bun add @unikvs/readonly

nub add @unikvs/readonly

aube add @unikvs/readonly

使い方

ReadOnly は IMiddleware を実装しています。UniKvs には use() で渡します。

import { ReadOnly } from "@unikvs/readonly";

ReadOnly

書き込みを拒否して読み取り専用にするミドルウェアです。

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

以下は、保存済みの値を読み戻す例です。

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

const storage = new Memory();
const writer = new unikvs.Builder<{
  foo: unikvs.Value<Uint8Array>;
}>()
  .persist(storage)
  .build();

await writer.open();
await writer.set("foo", new Uint8Array([0, 1, 2]));
await writer.close();

const kvs = new unikvs.Builder<{
  foo: unikvs.Value<Uint8Array>;
}>()
  .use(new ReadOnly())
  .persist(storage)
  .build();

await kvs.open();

const data = await kvs.get("foo");
console.log(data); // Uint8Array(3) [0, 1, 2]

await kvs.close();

データ型

• 書き込み方向は常に拒否し、読み取り方向の変換は行わず透過させます。
• copy と move はコピー先・移動先への書き込みを伴うため拒否します。
• 削除の可否は use() で制御し、allowDelete が false のときは delete・clear を拒否します。

エラー

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

ReadOnlySetNotAllowedError

意味

書き込み方向の操作 (set・copy・move・encode) が呼ばれたときに、このエラーが投げられます。

対処方法

書き込みが必要なときはこのミドルウェアを使わないでください。

例

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

import { ReadOnlySetNotAllowedError } from "@unikvs/readonly";

try {
  await kvs.set("foo", new Uint8Array([0, 1, 2]));
} catch (ex) {
  if (ex instanceof ReadOnlySetNotAllowedError) {
    console.log("書き込みは許可されていません");
  } else {
    throw ex;
  }
}

ReadOnlyDeleteNotAllowedError

意味

allowDelete が false のときに delete が呼ばれると、このエラーが投げられます。

対処方法

削除が必要なときは allowDelete: true を指定してください。

ReadOnlyClearNotAllowedError

意味

allowDelete が false のときに clear が呼ばれると、このエラーが投げられます。

対処方法

全件削除が必要なときは allowDelete: true を指定してください。