skills/docs/foundation/bitpacker/bitpacker-compressed/README.md

@suaveplan/bitpacker-compressed - Bitpacker compressed plugin

Summary

Compression pipeline integration for bitpacker.

Documentation tree

• deflate — (no submodules)
  • deflate — (no submodules)
• gzip — (no submodules)
  • gzip — (no submodules)
• none — (no submodules)
  • none — (no submodules)
• api — (no submodules)
  • api — (no submodules)
• compressed-bit-packer — (no submodules) - compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer — (no submodules) - compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer.schema — Zod schema for CompressedBitPackerOptions, the constructor options bundle accepted by CompressedBitPacker. Validate…
• otel — (no submodules)
  • instruments — (no submodules)
• register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…
  • register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…
• registry — (no submodules)
  • registry — (no submodules)
• rle — (no submodules) - rle.schema — Zod schema for the per-call `Compressi…
  • rle — (no submodules) - rle.schema — Zod schema for the per-call `Compressi…
  • rle.schema — Zod schema for the per-call CompressionOptions accepted by compressRle / decompressRle. The RLE codec is byte-onl…
• types — (no submodules) - types.schema — Zod schemas for the public type comp…
  • types — (no submodules) - types.schema — Zod schemas for the public type comp…
  • types.schema — Zod schemas for the public type companions of @suaveplan/bitpacker-compressed's compression pipeline: the open-record…
• index — Path: bitpacker-compressed/src/index.ts Export: See source for details.

- [deflate](./src/adapters/deflate/deflate.md) — _(no submodules)_- [gzip](./src/adapters/gzip/gzip.md) — _(no submodules)_- [gzip](./src/adapters/gzip/gzip.md) — _(no submodules)_- [none](./src/adapters/none/none.md) — _(no submodules)_- [none](./src/adapters/none/none.md) — _(no submodules)_- [api](./src/api/api.md) — _(no submodules)_- [api](./src/api/api.md) — _(no submodules)_- [compressed-bit-packer](./src/compressed-bit-packer/compressed-bit-packer.md) — _(no submodules)_- compressed-bit-packer.schema — Zod schema for `Comp…

• compressed-bit-packer — (no submodules)- compressed-bit-packer.schema — Zod schema for `Comp…
• compressed-bit-packer.schema — Zod schema for CompressedBitPackerOptions, the constructor options bundle accepted by CompressedBitPacker. Validate…
• otel — (no submodules)- instruments — (no submodules)- registry — (no submodules)- registry — (no submodules)- rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle.schema — Zod schema for the per-call CompressionOptions accepted by compressRle / decompressRle. The RLE codec is byte-onl…
• types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types.schema — Zod schemas for the public type companions of @suaveplan/bitpacker-compressed's compression pipeline: the open-record…
• index — Path: bitpacker-compressed/src/index.ts Export: See source for details.
• register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…
• deflate — (no submodules)- gzip — (no submodules)- gzip — (no submodules)- none — (no submodules)- none — (no submodules)- api — (no submodules)- api — (no submodules)- compressed-bit-packer — (no submodules)- compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer — (no submodules)- compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer.schema — Zod schema for CompressedBitPackerOptions, the constructor options bundle accepted by CompressedBitPacker. Validate…
• otel — (no submodules)- instruments — (no submodules)- registry — (no submodules)- registry — (no submodules)- rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle.schema — Zod schema for the per-call CompressionOptions accepted by compressRle / decompressRle. The RLE codec is byte-onl…
• types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types.schema — Zod schemas for the public type companions of @suaveplan/bitpacker-compressed's compression pipeline: the open-record…
• index — Path: bitpacker-compressed/src/index.ts Export: See source for details.
• register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…
• deflate — (no submodules)- gzip — (no submodules)- gzip — (no submodules)- none — (no submodules)- none — (no submodules)- api — (no submodules)- api — (no submodules)- compressed-bit-packer — (no submodules)- compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer — (no submodules)- compressed-bit-packer.schema — Zod schema for `Comp…
  • compressed-bit-packer.schema — Zod schema for CompressedBitPackerOptions, the constructor options bundle accepted by CompressedBitPacker. Validate…
• otel — (no submodules)- instruments — (no submodules)- registry — (no submodules)- registry — (no submodules)- rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle — (no submodules)- rle.schema — Zod schema for the per-call `Compressi…
  • rle.schema — Zod schema for the per-call CompressionOptions accepted by compressRle / decompressRle. The RLE codec is byte-onl…
• types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types — (no submodules)- types.schema — Zod schemas for the public type comp…
  • types.schema — Zod schemas for the public type companions of @suaveplan/bitpacker-compressed's compression pipeline: the open-record…
• index — Path: bitpacker-compressed/src/index.ts Export: See source for details.
• register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…
• deflate — (no submodules)- gzip — (no submodules) - gzip — (no submodules)- none — (no submodules) - none — (no submodules)- api — (no submodules) - api — (no submodules)- compressed-bit-packer — (no submodules) - compressed-bit-packer — (no submodules) - compressed-bit-packer.schema — Zod schema for CompressedBitPackerOptions, the constructor options bundle accepted by CompressedBitPacker. Validate…
• otel — (no submodules) - instruments — (no submodules)- registry — (no submodules) - registry — (no submodules)- rle — (no submodules) - rle — (no submodules) - rle.schema — Zod schema for the per-call CompressionOptions accepted by compressRle / decompressRle. The RLE codec is byte-onl…
• types — (no submodules) - types — (no submodules) - types.schema — Zod schemas for the public type companions of @suaveplan/bitpacker-compressed's compression pipeline: the open-record…
• index — Path: bitpacker-compressed/src/index.ts Export: See source for details.
• register-schemas — Idempotent integration with @suaveplan/schema-registry for the @suaveplan/bitpacker-compressed package. Exposes `re…

Install

bun add @suaveplan/bitpacker-compressed

Usage

import { compress, decompress } from "@suaveplan/bitpacker-compressed";

const data = new Uint8Array([1, 2, 3, 4, 5]);
const compressed = compress(data);
const restored = decompress(compressed);

Modules

• src/index.ts — compress, decompress