Skip to content

fix: update message header type to match #39

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 5 commits into
base: dev_early_access_development_branch
Choose a base branch
from
Open

fix: update message header type to match #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5918ddb
fix: update message header type to match
mkaufmaner May 6, 2024
d0277e3
fix: add null to message header type
mkaufmaner May 6, 2024
8bcea2d
fix: update message header types
mkaufmaner May 6, 2024
b92553a
fix: update header typing for nulls and numbers
mkaufmaner May 7, 2024
48550b9
fix: remove number from message header type
mkaufmaner May 15, 2024
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
1 change: 1 addition & 0 deletions .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module.exports = {
"env": {
"node": true,
"browser": true,
"commonjs": true,
"es2021": true
Expand Down
2 changes: 1 addition & 1 deletion types/kafkajs.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ export interface ProducerConstructorConfig extends ProducerGlobalConfig {
}

export interface IHeaders {
[key: string]: Buffer | string | (Buffer | string)[] | undefined
[key: string]: Buffer | string | number | null | (Buffer | string | number)[] | undefined
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the number type as we discussed

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made the change within the C++ side, so now an error is thrown for numeric header values

}

export interface Message {
Expand Down
10 changes: 6 additions & 4 deletions types/rdkafka.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,9 @@ export interface DeliveryReport extends TopicPartitionOffset {
export type NumberNullUndefined = number | null | undefined;

export type MessageKey = Buffer | string | null | undefined;
export type MessageHeader = { [key: string]: string | Buffer };
export type MessageHeaderValue = Buffer | string | null;
export type MessageHeader = Record<string, MessageHeaderValue>;
export type MessageHeaderList = MessageHeader[] | null | undefined;
export type MessageValue = Buffer | null;
export type SubscribeTopic = string | RegExp;
export type SubscribeTopicList = SubscribeTopic[];
Expand All @@ -107,7 +109,7 @@ export interface Message extends TopicPartitionOffset {
topic: string;
key?: MessageKey;
timestamp?: number;
headers?: MessageHeader[];
headers?: MessageHeaderList;
opaque?: any;
}

Expand Down Expand Up @@ -265,7 +267,7 @@ export class Producer extends Client<KafkaProducerEvents> {

poll(): this;

produce(topic: string, partition: NumberNullUndefined, message: MessageValue, key?: MessageKey, timestamp?: NumberNullUndefined, opaque?: any, headers?: MessageHeader[]): any;
produce(topic: string, partition: NumberNullUndefined, message: MessageValue, key?: MessageKey, timestamp?: NumberNullUndefined, opaque?: any, headers?: MessageHeaderList): any;

setPollInterval(interval: number): this;

Expand All @@ -284,7 +286,7 @@ export class Producer extends Client<KafkaProducerEvents> {

export class HighLevelProducer extends Producer {
produce(topic: string, partition: NumberNullUndefined, message: any, key: any, timestamp: NumberNullUndefined, callback: (err: any, offset?: NumberNullUndefined) => void): any;
produce(topic: string, partition: NumberNullUndefined, message: any, key: any, timestamp: NumberNullUndefined, headers: MessageHeader[], callback: (err: any, offset?: NumberNullUndefined) => void): any;
produce(topic: string, partition: NumberNullUndefined, message: any, key: any, timestamp: NumberNullUndefined, headers: MessageHeaderList, callback: (err: any, offset?: NumberNullUndefined) => void): any;

setKeySerializer(serializer: (key: any, cb: (err: any, key: MessageKey) => void) => void): void;
setKeySerializer(serializer: (key: any) => MessageKey | Promise<MessageKey>): void;
Expand Down