Skip to content

fix(types): expose cooperative-sticky rebalance methods on KafkaConsumer #485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dvir Arad (dvirarad) wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(types): expose cooperative-sticky rebalance methods on KafkaConsumer #485

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions types/rdkafka.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,14 @@ export class KafkaConsumer extends Client<KafkaConsumerEvents> {

assignments(): Assignment[];

/**
* Whether the current partition assignment was lost in the rebalance
* callback when partitions are revoked.
*
* Only meaningful when called from within the rebalance callback.
*/
assignmentLost(): boolean;

commit(topicPartition: TopicPartitionOffsetAndMetadata | TopicPartitionOffsetAndMetadata[]): this;
commit(): this;

Expand Down Expand Up @@ -254,6 +262,28 @@ export class KafkaConsumer extends Client<KafkaConsumerEvents> {

unassign(): this;

/**
* Incrementally add partitions to the consumer's current assignment.
* Required when using cooperative-sticky rebalancing — call from within
* the rebalance callback on `ERR__ASSIGN_PARTITIONS`.
*/
incrementalAssign(assignments: Assignment[]): this;

/**
* Incrementally remove partitions from the consumer's current assignment.
* Required when using cooperative-sticky rebalancing — call from within
* the rebalance callback on `ERR__REVOKE_PARTITIONS`.
*/
incrementalUnassign(assignments: Assignment[]): this;

/**
* Get the rebalance protocol in use by the consumer group.
*
* @returns "NONE" if not joined to a group yet, otherwise "COOPERATIVE"
* or "EAGER".
*/
rebalanceProtocol(): "NONE" | "COOPERATIVE" | "EAGER";

unsubscribe(): this;

offsetsForTimes(topicPartitions: TopicPartitionTime[], timeout: number, cb?: (err: LibrdKafkaError, offsets: TopicPartitionOffset[]) => any): void;
Expand Down