Skip to content

Fix add types for Admin and fix some type error #1440

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix add types for Admin and fix some type error #1440

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
46 changes: 39 additions & 7 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ export class ConsumerGroupStream extends Readable {
close (cb: () => any): void;
}

export class ConsumerGroup {
export class ConsumerGroup extends EventEmitter{
generationId: number;
memberId: string;
client: KafkaClient;
Expand All @@ -92,9 +92,9 @@ export class ConsumerGroup {
close (force: boolean, cb: (error: Error) => any): void;
close (cb: (error: Error) => any): void;

on (eventName: 'message', cb: (message: Message) => any): void;
on (eventName: 'error' | 'offsetOutOfRange', cb: (error: any) => any): void;
on (eventName: 'rebalancing' | 'rebalanced' | 'connect', cb: () => any): void;
on (eventName: 'message', cb: (message: Message) => any): this;
on (eventName: 'error' | 'offsetOutOfRange', cb: (error: any) => any): this;
on (eventName: 'rebalancing' | 'rebalanced' | 'connect', cb: () => any): this;

addTopics (topics: string[] | Topic[], cb?: (error: any, added: string[] | Topic[]) => any): void;

Expand All @@ -112,11 +112,11 @@ export class ConsumerGroup {
resume (): void;
}

export class Offset {
export class Offset extends EventEmitter{
constructor (client: KafkaClient);

on (eventName: 'ready' | 'connect', cb: () => any): void;
on (eventName: 'error', cb: (error: any) => any): void;
on (eventName: 'ready' | 'connect', cb: () => any): this;
on (eventName: 'error', cb: (error: any) => any): this;

fetch (payloads: OffsetRequest[], cb: (error: any, data: any) => any): void;

Expand Down Expand Up @@ -145,6 +145,23 @@ export class ProducerStream extends Writable {
_writev (chunks: Chunk[], cb: (error: any, data: any) => any): void;
}

export class Admin extends EventEmitter {
constructor(kafkaClient: KafkaClient);

on (eventName: 'ready' | 'connect', cb: () => any): this;
on (eventName: 'error', cb: () => any): this;

listGroups (cb: (error: any, res: any) => any): void;

listTopics (cb: (error: any, res: any) => any): void;

describeGroups (consumerGroups: Array<string>, cb: (error: any, res: any) => any): void;

createTopics (topics: Array<CreateTopicRequest>, cb: (error: any, res: any) => any): void;

describeConfigs (payload: DescribeConfigsRequest, cb: (error: any, res: any) => any): void;
}

// # Interfaces

export interface Message {
Expand Down Expand Up @@ -206,6 +223,7 @@ export interface ProduceRequest {
key?: string | Buffer;
partition?: number;
attributes?: number;
timestamp?:number; // defaults to Date.now() (only available with kafka v0.10+)
}

export interface ConsumerOptions {
Expand Down Expand Up @@ -348,3 +366,17 @@ export interface MetadataResponse extends Array<BrokerMetadataResponse|ClusterMe
0: BrokerMetadataResponse;
1: ClusterMetadataResponse;
}

export enum RESOURCE_TYPES {
topic = 'topic',
broker = 'broker'
}

export interface DescribeConfigsRequest {
resources: Array<{
resourceType: RESOURCE_TYPES,
resourceName: string,
configNames: Array<string>
}>,
includeSynonyms?: boolean
}