Skip to content
Kafka
Search documentation…
⌘ K
Search documentation
Search documentation
Esc
Start
Introduction
A TypeScript Kafka client for Kafka 0.10+
Installation
Install @cookiemonsterdev/kafka-core with npm, pnpm, yarn, or bun
Getting started
Create a client and send or consume messages
Guides
Producer
send, sendBatch, acks, linger, partitioners, and abort
Consumer
subscribe, run, stream, pause, seek, and assigners
Admin
Topics, configs, offsets, groups, ACLs, and SCRAM
Errors
Catch KafkaError, retries, and broker protocol codes
Security
TLS and SASL PLAIN, SCRAM, OAUTHBEARER, GSSAPI, and delegation tokens
Testing
Run unit and integration tests against a broker version
Throughput
Throughput preset, linger and batching, and the heavy-load consume API
Observability
Client-side OpenTelemetry metrics from instrumentation events
Reference
Kafka client
new Kafka, producer, consumer, admin, and logger
Producer API
Producer methods, Message, and RecordMetadata
Consumer API
Consumer methods, KafkaMessage, and run options
Admin API
Implemented admin methods
Configuration
KafkaConfig, ProducerConfig, ConsumerConfig, and AdminConfig
Errors
Public error classes and broker protocol codes
Public API
What @cookiemonsterdev/kafka-core exports
Compatibility
Broker support and constructor defaults, the implemented surface, and APIs this client does not implement
Migration
Breaking changes
Offsets as bigint, MessageSet, built-in ZSTD, and environment variables
Package
Core
Node.js client
Search documentation…
Start
Guides
Reference
Integrations
Migration
GitHub
The TypeScript Kafka client for Node.js
Talk to brokers from Kafka 0.10 onward. Produce, consume, and administer.
Get started
Introduction
npm install @cookiemonsterdev/kafka-core