Skip to content

Commit 717ec67

Browse files
committed
Update MIGRATION.md for eachBatch
1 parent ca1e002 commit 717ec67

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

MIGRATION.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -298,11 +298,15 @@ producerRun().then(consumerRun).catch(console.error);
298298
eachMessage: someFunc,
299299
});
300300
```
301-
- The `heartbeat()` no longer needs to be called by the user in the `eachMessage/eachBatch` callback. Heartbeats are automatically managed by librdkafka.
302-
- The `partitionsConsumedConcurrently` property is not supported at the moment.
303-
- An API compatible version of `eachBatch` is available, but the batch size never exceeds 1.
304-
The property `eachBatchAutoResolve` is supported. Within the `eachBatch` callback, use of `uncommittedOffsets` is unsupported,
305-
and within the returned batch, `offsetLag` and `offsetLagLow` are unsupported, and `commitOffsetsIfNecessary` is a no-op.
301+
- The `heartbeat()` no longer needs to be called by the user in the `eachMessage/eachBatch` callback.
302+
Heartbeats are automatically managed by librdkafka.
303+
- The `partitionsConsumedConcurrently` is supported by both `eachMessage` and `eachBatch`.
304+
- An API compatible version of `eachBatch` is available, but the batch size calculation is not
305+
as per configured parameters, rather, a constant maximum size is configured internally. This is subject
306+
to change.
307+
The property `eachBatchAutoResolve` is supported.
308+
Within the `eachBatch` callback, use of `uncommittedOffsets` is unsupported,
309+
and within the returned batch, `offsetLag` and `offsetLagLow` are unsupported.
306310
* `commitOffsets`:
307311
- Does not yet support sending metadata for topic partitions being committed.
308312
- If called with no arguments, it commits all offsets passed to the user (or the stored offsets, if manually handling offset storage using `consumer.storeOffsets`).

0 commit comments

Comments
 (0)