lz4-kafkajs

TypeScript-ready lz4 compression codec for KafkaJS.

ℹ️ Requires Node v10 or above to work.

Install

With yarn

1$ yarn add lz4-kafkajs

With npm

1$ npm install lz4-kafkajs

Usage

1import { CompressionTypes, CompressionCodecs } from "kafkajs";
2import LZ4 from "lz4-kafkajs";
3
4CompressionCodecs[CompressionTypes.LZ4] = new LZ4().codec;

Options

All options are passed on to the lz4 library.

Example

To configure the decompression and compression:

1import LZ4, {
2  CompressOptions,
3  DecompressOptions,
4  LZ4Options,
5} from "lz4-kafkajs";
6
7const decompressOptions: DecompressOptions = {
8  useJS: false,
9};
10
11const compressOptions: CompressOptions = {
12  blockChecksum: false,
13  blockIndependence: true,
14  blockMaxSize: 4 << 20,
15  dict: false,
16  dictId: 0,
17  highCompression: false,
18  streamChecksum: true,
19  streamSize: false,
20};
21
22const options: LZ4Options = {
23  decompressOptions,
24  compressOptions,
25};
26
27CompressionCodecs[CompressionTypes.LZ4] = new LZ4(options).codec;