@unikvs/compression

How to use @unikvs/compression, middleware that compresses and decompresses bytes in a given format.

Overview

Middleware that compresses and decompresses bytes in a given format. Middleware

It converts both single reads/writes and streams transparently, without changing caller types.

• name is "Compression".
• isOpen is always true.
• Available formats depend on the runtime’s CompressionStream and DecompressionStream.

Install with:

npm install @unikvs/compression

pnpm add @unikvs/compression

yarn add @unikvs/compression

bun add @unikvs/compression

nub add @unikvs/compression

aube add @unikvs/compression

Usage

Compression implements IMiddleware. Pass it to UniKvs with use().

import { Compression } from "@unikvs/compression";

Constructor arguments:

The following example stores bytes compressed with gzip and decompresses them on read.

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

const kvs = new unikvs.Builder<{ file: unikvs.Value<Uint8Array> }>()
  .use(new Compression("gzip"))
  .persist(new Memory())
  .build();

await kvs.open();
await kvs.set("file", new Uint8Array([0x01, 0x02, 0x03]));
const file = await kvs.get("file");
await kvs.close();

Data types

• encode compresses bytes in the given format.
• decode decompresses compressed bytes in the given format.
• encodeStream passes the stream through CompressionStream as-is.
• decodeStream passes the stream through DecompressionStream as-is.
• Chunk boundaries are left to the compressor and decompressor.

Errors

This package has no package-specific errors.

If an unsupported format is specified or corrupted data is decompressed, the runtime’s native error propagates unchanged.