@unikvs/zstd.wasm

WebAssembly の Zstandard 実装で圧縮と展開を行うミドルウェアです。

概要

@unikvs/zstd.wasm はバイト列を Zstandard で圧縮して保存し、読み取り時に展開するプラグインです。Middleware

このミドルウェアは @bokuweb/zstd-wasm を動的 import で遅延解決し、初期化してから使います。実行環境を選ばずに Zstandard を使いたい場合に向いています。

• name は ZstdWasm です。
• isOpen は open() 後に true になります。初期状態では false です。
• ストリーム用の encodeStream と decodeStream は提供しません。一括変換のみに対応します。

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

npm install @unikvs/zstd.wasm @logtape/logtape

pnpm add @unikvs/zstd.wasm @logtape/logtape

yarn add @unikvs/zstd.wasm @logtape/logtape

bun add @unikvs/zstd.wasm @logtape/logtape

nub add @unikvs/zstd.wasm @logtape/logtape

aube add @unikvs/zstd.wasm @logtape/logtape

使い方

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

import { ZstdWasm } from "@unikvs/zstd.wasm";

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

以下は、書き込んだ値を Zstandard で圧縮して保存し、読み取り時に展開する例です。

import { Memory } from "@unikvs/memory";
import * as unikvs from "unikvs";
import { ZstdWasm } from "@unikvs/zstd.wasm";

const kvs = new unikvs.Builder<{ foo: unikvs.Value<Uint8Array> }>()
  .use(new ZstdWasm({ level: 3 }))
  .persist(new Memory())
  .build();

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

const bytes = await kvs.get("foo");
console.log(bytes); // 展開されたバイト列になります

await kvs.close();

データ型

• encode では入力バイト列を Zstandard で圧縮します。
• decode では入力バイト列を Zstandard で展開します。
• ストリーム用の encodeStream と decodeStream は提供しません。

エラー

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

ZstdWasmInitError

意味

open() で @bokuweb/zstd-wasm モジュールの初期化に失敗したときに、このエラーが投げられます。

対処方法

@bokuweb/zstd-wasm が正しくインストールされているか、ブラウザーでは WASM ファイルを取得できるか確認してください。

例

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

import { Memory } from "@unikvs/memory";
import * as unikvs from "unikvs";
import { ZstdWasm, ZstdWasmInitError } from "@unikvs/zstd.wasm";

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

try {
  await kvs.open();
} catch (ex) {
  if (ex instanceof ZstdWasmInitError) {
    console.log("初期化に失敗しました");
  } else {
    throw ex;
  }
}

ZstdWasmInvalidLevelError

意味

コンストラクターは level が 1 から 22 までの整数ではないときに、このエラーを投げます。

対処方法

1 から 22 までの整数を指定してください。省略した場合は 3 になります。

例

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

import { ZstdWasm, ZstdWasmInvalidLevelError } from "@unikvs/zstd.wasm";

try {
  new ZstdWasm({ level: 0 });
} catch (ex) {
  if (ex instanceof ZstdWasmInvalidLevelError) {
    console.log(ex.meta); // { actual: 0 }
  } else {
    throw ex;
  }
}

このミドルウェアは open() 前に encode などを呼ばれると TypeError を投げます。展開に失敗した場合は上流のエラーをそのまま伝播します。