@unikvs/null

@unikvs/null の Null。書き込みを破棄するテスト用ストレージの使い方を説明します。

概要

@unikvs/null はすべての書き込みを破棄し、読み取りを常に失敗させるテスト用ストレージです。パイプラインの動作確認や、保存を一時的に無効化したい場合に使います。

• name は Null です。
• isOpen は常に true です。
• open・close はありません。

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

npm install @unikvs/null

pnpm add @unikvs/null

yarn add @unikvs/null

bun add @unikvs/null

nub add @unikvs/null

aube add @unikvs/null

使い方

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

import { Null } from "@unikvs/null";

以下は、書き込みが破棄されることを確認する例です。

import { Null } from "@unikvs/null";
import * as unikvs from "unikvs";

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

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

console.log(await kvs.has("greeting")); // false

await kvs.close();

データ型

• 書き込んだ値はすべて破棄します。
• read・delete・getReadable は常に KeyNotFoundError を投げます。
• exists は常に false を返します。
• clear は何も行いません。
• getWritable は書き込まれたチャンクをすべて破棄します。

エラー

このパッケージ固有のエラーはありません。読み取りが失敗したときは、@unikvs/core の共通エラーである KeyNotFoundError を投げます。