Skip to content

Add overload typings for all event types #1202

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

Merged
merged 2 commits into from
Nov 26, 2021
Merged

Add overload typings for all event types #1202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a3cbb0
Add overload typings for all event types
brianphillips Oct 7, 2021
f2b55ce
Merge branch 'master' into better-event-typings
Nevon Nov 22, 2021
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
6 changes: 1 addition & 5 deletions src/admin/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1457,11 +1457,7 @@ module.exports = ({
})
}

/**
* @param {string} eventName
* @param {Function} listener
* @return {Function}
*/
/** @type {import("../../types").Admin["on"]} */
const on = (eventName, listener) => {
if (!eventNames.includes(eventName)) {
throw new KafkaJSNonRetriableError(`Event name should be one of ${eventKeys}`)
Expand Down
6 changes: 1 addition & 5 deletions src/producer/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,7 @@ module.exports = ({

let transactionalEosManager

/**
* @param {string} eventName
* @param {AsyncFunction} listener
* @return {Function} removeListener
*/
/** @type {import("../../types").Producer["on"]} */
const on = (eventName, listener) => {
if (!eventNames.includes(eventName)) {
throw new KafkaJSNonRetriableError(`Event name should be one of ${eventKeys}`)
Expand Down
32 changes: 29 additions & 3 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,9 +479,14 @@ export type Admin = {
createAcls(options: { acl: AclEntry[] }): Promise<boolean>
deleteTopicRecords(options: { topic: string; partitions: SeekEntry[] }): Promise<void>
logger(): Logger
on(eventName: AdminEvents['CONNECT'], listener: (event: ConnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: AdminEvents['DISCONNECT'], listener: (event: DisconnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: AdminEvents['REQUEST'], listener: (event: RequestEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: AdminEvents['REQUEST_QUEUE_SIZE'], listener: (event: RequestQueueSizeEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: AdminEvents['REQUEST_TIMEOUT'], listener: (event: RequestTimeoutEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(
eventName: ValueOf<AdminEvents>,
listener: (...args: any[]) => void
listener: (event: InstrumentationEvent<any>) => void
): RemoveInstrumentationEventListener<typeof eventName>
readonly events: AdminEvents
}
Expand Down Expand Up @@ -679,9 +684,14 @@ export type Producer = Sender & {
disconnect(): Promise<void>
isIdempotent(): boolean
readonly events: ProducerEvents
on(eventName: ProducerEvents['CONNECT'], listener: (event: ConnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: ProducerEvents['DISCONNECT'], listener: (event: DisconnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: ProducerEvents['REQUEST'], listener: (event: RequestEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: ProducerEvents['REQUEST_QUEUE_SIZE'], listener: (event: RequestQueueSizeEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(eventName: ProducerEvents['REQUEST_TIMEOUT'], listener: (event: RequestTimeoutEvent) => void): RemoveInstrumentationEventListener<typeof eventName>;
on(
eventName: ValueOf<ProducerEvents>,
listener: (...args: any[]) => void
listener: (event: InstrumentationEvent<any>) => void
): RemoveInstrumentationEventListener<typeof eventName>
transaction(): Promise<Transaction>
logger(): Logger
Expand Down Expand Up @@ -896,9 +906,25 @@ export type Consumer = {
pause(topics: Array<{ topic: string; partitions?: number[] }>): void
paused(): TopicPartitions[]
resume(topics: Array<{ topic: string; partitions?: number[] }>): void
on(eventName: ConsumerEvents['HEARTBEAT'], listener: (event: ConsumerHeartbeatEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['COMMIT_OFFSETS'], listener: (event: ConsumerCommitOffsetsEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['GROUP_JOIN'], listener: (event: ConsumerGroupJoinEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['FETCH_START'], listener: (event: InstrumentationEvent<{}>) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['FETCH'], listener: (event: ConsumerFetchEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['START_BATCH_PROCESS'], listener: (event: ConsumerStartBatchProcessEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['END_BATCH_PROCESS'], listener: (event: ConsumerEndBatchProcessEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['CONNECT'], listener: (event: ConnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['DISCONNECT'], listener: (event: DisconnectEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['STOP'], listener: (event: InstrumentationEvent<null>) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['CRASH'], listener: (event: ConsumerCrashEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['REBALANCING'], listener: (event: ConsumerRebalancingEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['RECEIVED_UNSUBSCRIBED_TOPICS'], listener: (event: ConsumerReceivedUnsubcribedTopicsEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['REQUEST'], listener: (event: RequestEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['REQUEST_TIMEOUT'], listener: (event: RequestTimeoutEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(eventName: ConsumerEvents['REQUEST_QUEUE_SIZE'], listener: (event: RequestQueueSizeEvent) => void): RemoveInstrumentationEventListener<typeof eventName>
on(
eventName: ValueOf<ConsumerEvents>,
listener: (...args: any[]) => void
listener: (event: InstrumentationEvent<any>) => void
): RemoveInstrumentationEventListener<typeof eventName>
logger(): Logger
readonly events: ConsumerEvents
Expand Down