You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**confluent-kafka-js** is Confluent's JavaScript client for [Apache Kafka](http://kafka.apache.org/) and the
5
+
[Confluent Platform](https://www.confluent.io/product/compare/). This is an **early access** library. The goal is to provide an highly performant, reliable and easy to use JavaScript client that is based on [node-rdkafka](https://github.com/Blizzard/node-rdkafka) yet also API compatible with [KafkaJS](https://github.com/tulios/kafkajs) to provide flexibility to users and streamline migrations from other clients.
6
6
7
+
This library leverages the work and concepts from two popular Apache Kafka JavaScript clients: [node-rdkafka](https://github.com/Blizzard/node-rdkafka) and [KafkaJS](https://github.com/tulios/kafkajs). The core is heavily based on the node-rdkafka library, which uses our own [librdkafka](https://github.com/confluentinc/librdkafka/tree/v2.3.0) library for core client functionality. However, we leverage a promisified API and a more idiomatic interface, similar to the one in KafkaJS, making it easy for developers to migrate and adopt this client depending on the patterns and interface they prefer.
8
+
__This library currently uses `librdkafka` based off of the master branch.__
7
9
8
-
Features:
9
-
10
-
-**High performance** - confluent-kafka-js is a lightweight wrapper around
11
-
[librdkafka](https://github.com/confluentinc/librdkafka), a finely tuned C
12
-
client.
13
-
14
-
-**Reliability** - There are a lot of details to get right when writing an Apache Kafka
15
-
client. We get them right in one place (librdkafka) and leverage this work
16
-
across all of our clients (also [confluent-kafka-python](https://github.com/confluentinc/confluent-kafka-python),
17
-
[confluent-kafka-go](https://github.com/confluentinc/confluent-kafka-go) and
18
-
and [confluent-kafka-dotnet](https://github.com/confluentinc/confluent-kafka-dotnet)).
10
+
## This library is currently in early access and not meant for production use
19
11
20
-
-**Future proof** - Confluent, founded by the
21
-
creators of Kafka, is building a [streaming platform](https://www.confluent.io/product/compare/)
22
-
with Apache Kafka at its core. It's high priority for us that client features keep
23
-
pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/compare/).
12
+
**This library is in active development, pre-1.0.0, and it is likely to have many breaking changes.**
24
13
25
-
## This library is currently not ready for production use. It's an early-access preview in active development, pre-1.0.0, and there might be breaking changes.
14
+
For this early-access release, we aim to get feedback from JavaScript developers within the Apache Kafka community to help meet your needs. Some areas of feedback we are looking for include:
15
+
- Usability of the API compared to other clients
16
+
- Migration experience from the node-rdkafka and KafkaJs
17
+
- Overall quality and reliability
26
18
27
-
This library is based heavily on [node-rdkafka](https://github.com/Blizzard/node-rdkafka).
19
+
We invite you to raise issues to highlight any feedback you may have.
28
20
29
-
This library contains a promisified API, very similar to the one in [kafkajs](https://github.com/tulios/kafkajs). Some of the tests are also based on the ones in kafkajs.
21
+
Within the early-access, only **basic produce and consume functionality** as well as the ability to **create and delete topics** are supported. All other admin client functionality is coming in future releases. See [INTRODUCTION.md](INTRODUCTION.md) for more details on what is supported.
30
22
31
-
__This library currently uses `librdkafka` based off of the master branch.__
23
+
To use **Schema Registry**, use the existing [kafkajs/confluent-schema-registry](https://github.com/kafkajs/confluent-schema-registry)library that is compatible with this library. For a simple schema registry example, see [sr.js](https://github.com/confluentinc/confluent-kafka-js/blob/dev_early_access_development_branch/examples/kafkajs/sr.js).
32
24
33
25
34
26
## Requirements
@@ -39,8 +31,7 @@ The following configurations are supported for this early access preview:
39
31
* Linux (x64 and arm64) - both glibc and musl/alpine.
40
32
* macOS - arm64/m1.
41
33
42
-
Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required. It can be installed
43
-
from GitHub:
34
+
Installation on any of these platforms is meant to be seamless, without any C/C++ compilation required. It can be installed from GitHub:
0 commit comments