Skip to content

Commit eb73d5b

Browse files
authored
Allow null in consumer commitSync typings (#1082)
KafkaConsumer incorrectly requires that commitSync be supplied with a TopicPartitionOffset or an array of TopicPartitionOffsets, when docs say that null can be passed to commit all read offsets.
1 parent 020db59 commit eb73d5b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ export class KafkaConsumer extends Client<KafkaConsumerEvents> {
218218

219219
commitMessageSync(msg: TopicPartitionOffset): this;
220220

221-
commitSync(topicPartition: TopicPartitionOffset | TopicPartitionOffset[]): this;
221+
commitSync(topicPartition: TopicPartitionOffset | TopicPartitionOffset[] | null): this;
222222

223223
committed(toppars: TopicPartition[], timeout: number, cb: (err: LibrdKafkaError, topicPartitions: TopicPartitionOffset[]) => void): this;
224224
committed(timeout: number, cb: (err: LibrdKafkaError, topicPartitions: TopicPartitionOffset[]) => void): this;

0 commit comments

Comments
 (0)