@unikvs/passthrough

Middleware that passes data through without conversion.

Overview

@unikvs/passthrough passes data through without any conversion.Middleware

It fits empty pipeline slots or serves as a base for custom middleware. Alone, it never changes stored content.

• name is PassThrough.
• isOpen is always true. open() is unnecessary.

Install with:

npm install @unikvs/passthrough @logtape/logtape

pnpm add @unikvs/passthrough @logtape/logtape

yarn add @unikvs/passthrough @logtape/logtape

bun add @unikvs/passthrough @logtape/logtape

nub add @unikvs/passthrough @logtape/logtape

aube add @unikvs/passthrough @logtape/logtape

Usage

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

import { PassThrough } from "@unikvs/passthrough";

The following stores a value through passthrough and reads it back unchanged:

import { Memory } from "@unikvs/memory";
import { PassThrough } from "@unikvs/passthrough";
import * as unikvs from "unikvs";

const kvs = new unikvs.Builder<{ foo: unikvs.Value<Uint8Array> }>()
  .use(new PassThrough())
  .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); // Uint8Array(3) [0, 1, 2]

await kvs.close();

Data types

• encode outputs the input data unchanged.
• decode outputs the input data unchanged.
• encodeStream outputs the input stream unchanged.
• decodeStream outputs the input stream unchanged.

Errors

This package has no package-specific errors.