Merge pull request #951 from ankon/pr/consumer-group-state

Document the possible values for the state of a consumer group
tulios · Nov 11, 2020 · daeec89 · daeec89
2 parents a46d2a0 + 05bf209
commit daeec89
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -657,12 +657,15 @@ export type MemberDescription = {
   memberMetadata: Buffer
 }
 
+// See https://github.com/apache/kafka/blob/2.4.0/clients/src/main/java/org/apache/kafka/common/ConsumerGroupState.java#L25
+export type ConsumerGroupState = 'Unknown' | 'PreparingRebalance' | 'CompletingRebalance' | 'Stable' | 'Dead' | 'Empty';
+
 export type GroupDescription = {
   groupId: string
   members: MemberDescription[]
   protocol: string
   protocolType: string
-  state: string
+  state: ConsumerGroupState
 }
 
 export type GroupDescriptions = {