Merge pull request #839 from tulios/improve-fetch-topic-offset-types

Improve types
tulios · Aug 20, 2020 · 983c3d7 · 983c3d7
2 parents 2c9cddb + d698c04
commit 983c3d7
Show file tree

Hide file tree

Showing 7 changed files with 51 additions and 11 deletions.
diff --git a/src/admin/index.js b/src/admin/index.js
@@ -44,6 +44,16 @@ const findTopicPartitions = async (cluster, topic) => {
     .sort()
 }
 
+/**
+ *
+ * @param {Object} params
+ * @param {import("../../types").Logger} params.logger
+ * @param {import('../instrumentation/emitter')} [params.instrumentationEmitter]
+ * @param {import('../../types').RetryOptions} params.retry
+ * @param {import("../../types").Cluster} params.cluster
+ *
+ * @returns {import("../../types").Admin}
+ */
 module.exports = ({
   logger: rootLogger,
   instrumentationEmitter: rootInstrumentationEmitter,
@@ -285,7 +295,7 @@ module.exports = ({
 
   /**
    * @param {string} topic
-   * @param {number=} timestamp
+   * @param {number} [timestamp]
    */
 
   const fetchTopicOffsetsByTimestamp = async (topic, timestamp) => {

diff --git a/src/cluster/index.js b/src/cluster/index.js
@@ -32,7 +32,7 @@ const mergeTopics = (obj, { topic, partitions }) => ({
  * @param {number} metadataMaxAge - in milliseconds
  * @param {boolean} allowAutoTopicCreation
  * @param {number} maxInFlightRequests
- * @param {IsolationLevel} isolationLevel
+ * @param {number} isolationLevel
  * @param {Object} retry
  * @param {Logger} logger
  * @param {Map} offsets

diff --git a/src/consumer/index.js b/src/consumer/index.js
@@ -24,6 +24,24 @@ const specialOffsets = [
 ]
 
 /**
+ * @param {Object} params
+ * @param {import("../../types").Cluster} params.cluster
+ * @param {String} params.groupId
+ * @param {import('../../types').RetryOptions} params.retry
+ * @param {import('../../types').Logger} params.logger
+ * @param {import('../../types').PartitionAssigner[]} [params.partitionAssigners]
+ * @param {number} [params.sessionTimeout]
+ * @param {number} [params.rebalanceTimeout]
+ * @param {number} [params.heartbeatInterval]
+ * @param {number} [params.maxBytesPerPartition]
+ * @param {number} [params.minBytes]
+ * @param {number} [params.maxBytes]
+ * @param {number} [params.maxWaitTimeInMs]
+ * @param {number} [params.isolationLevel]
+ * @param {string} [params.rackId]
+ * @param {import('../instrumentation/emitter')} [params.instrumentationEmitter]
+ * @param {number} params.metadataMaxAge
+ *
  * @returns {import("../../types").Consumer}
  */
 module.exports = ({

diff --git a/src/instrumentation/emitter.js b/src/instrumentation/emitter.js
@@ -2,9 +2,6 @@ const EventEmitter = require('events')
 const InstrumentationEvent = require('./event')
 const { KafkaJSError } = require('../errors')
 
-/**
- * @typedef InstrumentationEventEmitter
- */
 module.exports = class InstrumentationEventEmitter {
   constructor() {
     this.emitter = new EventEmitter()

diff --git a/src/producer/index.js b/src/producer/index.js
@@ -14,6 +14,20 @@ const eventKeys = keys(events)
 
 const { CONNECT, DISCONNECT } = events
 
+/**
+ *
+ * @param {Object} params
+ * @param {import('../../types').Cluster} params.cluster
+ * @param {import('../../types').Logger} params.Logger
+ * @param {import('../../types').ICustomPartitioner} [params.createPartitioner]
+ * @param {import('../../types').RetryOptions} params.retry
+ * @param {boolean} [params.idempotent]
+ * @param {string} [params.transactionalId]
+ * @param {number} [params.transactionTimeout]
+ * @param {import('../instrumentation/emitter')} [params.instrumentationEmitter]
+ *
+ * @returns {import('../../types').Producer}
+ */
 module.exports = ({
   cluster,
   logger: rootLogger,

diff --git a/src/protocol/isolationLevel.js b/src/protocol/isolationLevel.js
@@ -1,7 +1,7 @@
 /**
  * Enum for isolation levels
  * @readonly
- * @enum {IsolationLevel}
+ * @enum {number}
  */
 module.exports = {
   // Makes all records visible

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -3,6 +3,9 @@
 import * as tls from 'tls'
 import * as net from 'net'
 
+type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
+type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
+
 export class Kafka {
   constructor(config: KafkaConfig)
   producer(config?: ProducerConfig): Producer
@@ -136,9 +139,7 @@ export type Cluster = {
     topics: Array<{
       topic: string
       partitions: Array<{ partition: number }>
-      fromBeginning?: boolean
-      fromTimestamp?: number
-    }>
+    } & XOR<{ fromBeginning: boolean }, { fromTimestamp: number }>>
   ): Promise<{ topic: string; partitions: Array<{ partition: number; offset: string }> }>
 }
 
@@ -423,7 +424,7 @@ export type Broker = {
     maxWaitTime?: number,
     minBytes?: number,
     maxBytes?: number,
-    topics: Array<{ topic: string, partitions: Array<{ partition: number; fetchOffset: string; maxBytes: number }>}>,
+    topics: Array<{ topic: string, partitions: Array<{ partition: number; fetchOffset: string; maxBytes: number }> }>,
     rackId?: string,
   }): Promise<any>
 }
@@ -797,7 +798,7 @@ export class KafkaJSUnsupportedMagicByteInMessageSet extends KafkaJSError {
 }
 
 export class KafkaJSDeleteGroupsError extends KafkaJSError {
-  constructor(e: Error | string, groups?: KafkaJSDeleteGroupsErrorGroups[] )
+  constructor(e: Error | string, groups?: KafkaJSDeleteGroupsErrorGroups[])
 }
 
 export interface KafkaJSDeleteGroupsErrorGroups {