Skip to content

🗜 LZ4 compression codec for KafkaJS

License

Notifications You must be signed in to change notification settings

CaptainUp/kafkajs-lz4

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

kafkajs-lz4

Build Status NPM Version

TypeScript-ready lz4 compression codec for KafkaJS.

Install

$ yarn install kafkajs-lz4

Usage

import { CompressionTypes, CompressionCodecs } from 'kafkajs';
import LZ4Codec from 'kafkajs-lz4';

CompressionCodecs[CompressionTypes.LZ4] = new LZ4Codec().codec;

Options

All options are transparently passed on to the lz4 library's synchronous encoding options.

Example

To allow encoding Kafka messages of up to 25 MB in size —

const lz4Codec = new LZ4Codec({
    blockMaxSize: 26214400
}).codec;

CompressionCodecs[CompressionTypes.LZ4] = lz4Codec;

About

🗜 LZ4 compression codec for KafkaJS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 73.0%
  • Shell 14.0%
  • JavaScript 13.0%