confluent-kafka-javascript

(★ 301)

Confluent's Apache Kafka JavaScript client

File Explorer

Download Latest Version (.zip)

- - bug_report.md
- CODEOWNERS
- pull_request_template.md
- stale.yml
- build-docker-alpine.sh
- build-docker-debian.sh
- docker_run_with_volumes.sh
- post_install.yml
- semaphore.yml
- consumer-raw-rdkafka.js
- consumer-subscribe.js
- kafka-consumer-stream.js
- producer-raw-rdkafka.js
- producer-rdkafka.js
- seed.sh
- - librdkafka-correct-version.js
  - librdkafka-exists.js
- - _install_ckjs.sh
  - _install_nvm.sh
  - install-alpine.sh
  - install-debian.sh
  - install-mac.sh
  - install-rhel.sh
- - run_perf_test.sh
- librdkafka-defs-generator.js
- prepublish.js
- update-version.js
- librdkafka
- librdkafka.gyp
- windows-install.py
- admin-dependent.spec.js
- admin.spec.js
- both.spec.js
- consumer.spec.js
- groups.spec.js
- listener.js
- oauthbearer_cb.spec.js
- producer-transaction.spec.js
- producer.spec.js
- topicUtils.js
- - consumer-confluent-cloud.js
  - consumer.js
  - eos.js
  - oauthbearer_oidc_azure_imds.js
  - producer-confluent-cloud.js
  - producer.js
  - sr.js
- - consumer-confluent-cloud.md
  - consumer-flow.md
  - consumer.md
  - dependent-admin.js
  - docker-alpine.md
  - high-level-producer-confluent-cloud.md
  - high-level-producer.md
  - metadata.md
  - producer-cluster.md
  - producer.md
- - package-lock.json
  - package.json
  - performance-consolidated.js
  - performance-primitives-kafkajs.js
  - performance-primitives.js
  - README.md
- - .gitignore
  - kafkajs.ts
  - node-rdkafka.ts
  - package.json
- consumer-confluent-cloud.js
- consumer.js
- eos.js
- package.json
- producer-confluent-cloud.js
- producer.js
- - _admin.js
  - _common.js
  - _consumer.js
  - _consumer_cache.js
  - _error.js
  - _kafka.js
  - _linked-list.js
  - _producer.js
  - index.js
- - high-level-producer.js
- - ref-counter.js
- admin.js
- client.js
- error.js
- index.js
- kafka-consumer-stream.js
- kafka-consumer.js
- producer-stream.js
- producer.js
- rdkafka.js
- topic-partition.js
- topic.js
- util.js
- - meta.proto
- - meta_pb.ts
- - schemaregistry-avro.spec.ts
  - schemaregistry-client.spec.ts
  - schemaregistry-json.spec.ts
- - abstract-oauth-client.ts
  - bearer-token-provider.ts
  - oauth-client-azure-imds.ts
  - oauth-client.ts
  - static-token-provider.ts
- - avro.ts
  - buffer-wrapper.ts
  - json-util.ts
  - json.ts
  - protobuf.ts
  - rule-registry.ts
  - serde.ts
  - wildcard-matcher.ts
- - mock-schemaregistery-client.spec.ts
  - oauth-client-azure-imds.spec.ts
  - oauth-client.spec.ts
  - rest-service.spec.ts
  - schemaregistry-client.spec.ts
  - test-constants.ts
- docker-compose.schemaregistry.yml
- index.ts
- jest.config.js
- LICENSE.txt
- Makefile
- mock-schemaregistry-client.ts
- package.json
- README.md
- rest-error.ts
- rest-service.ts
- retry-helper.ts
- run_docker_schemaregistry.sh
- schemaregistry-client.ts
- tsconfig-build.json
- tsconfig.json
- - constants.ts
  - csfle-schemaregistry.ts
  - kafka-consumer-avro.ts
  - kafka-consumer-json.ts
  - kafka-oauth.ts
  - kafka-producer-avro.ts
  - kafka-producer-json.ts
  - local-schemaregistry.ts
  - oauth-schemaregistry.ts
  - uami-oauth-schemaregistry.ts
- jest.config.js
- package.json
- tsconfig.json
- update-changelog.py
- admin.cc
- admin.h
- binding.cc
- binding.h
- callbacks.cc
- callbacks.h
- common.cc
- common.h
- config.cc
- config.h
- connection.cc
- connection.h
- errors.cc
- errors.h
- kafka-consumer.cc
- kafka-consumer.h
- producer.cc
- producer.h
- topic.cc
- topic.h
- workers.cc
- workers.h
- - docker-compose-kraft.yml
  - docker-compose.yml
  - kafka_jaas.conf
- - high-level-producer.spec.js
- - oauthbearer_cb.spec.js
  - testhelpers.js
- - ref-counter.spec.js
- binding.spec.js
- consumer.spec.js
- error.spec.js
- index.spec.js
- kafka-consumer-stream.spec.js
- kafka-consumer.spec.js
- mocha.opts
- mock.js
- producer-stream.spec.js
- producer.spec.js
- topic-partition.spec.js
- util.spec.js
- config.d.ts
- errors.d.ts
- kafkajs.d.ts
- rdkafka.d.ts
- configure.js
- generate-docs.sh
- get-env.js
- test-compile.js
- test-producer-delivery.js
.editorconfig
.gitignore
.gitmodules
.npmignore
binding.gyp
buf.gen.yaml
CHANGELOG.md
configure
CONTRIBUTING.md
cpplint.py
deploy.enc
eslint.config.js
index.d.ts
INTRODUCTION.md
jest.config.js
jsdoc.conf
librdkafka.js
LICENSE.kafkajs
LICENSE.node-rdkafka
LICENSE.txt
make_docs.sh
Makefile
MIGRATION.md
package-lock.json
package.json
QUICKSTART.md
README.md
run_docker.sh
SECURITY.md
service.yml
sonar-project.properties
tsconfig.json
win_install.ps1

# Installation Guide

1. Get the code

git clone https://github.com/confluentinc/confluent-kafka-javascript

Downloads the entire project code from GitHub to your computer.

cd confluent-kafka-javascript

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f schemaregistry/docker-compose.schemaregistry.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install @confluentinc/kafka-javascript

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.