fix(types): queue tolerance

SkeLLLa · Jan 3, 2025 · 9719af7 · 9719af7
1 parent caa34c1
commit 9719af7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/src/client/broker/transport/json/undici.ts b/src/client/broker/transport/json/undici.ts
@@ -70,7 +70,7 @@ export class PinotBrokerJSONTransport implements IPinotBrokerTransport {
   }: IBrokerTransportRequestOptions): Promise<TResponse> {
     const queueSize = this.pool.stats.queued;
     const maxQueueTolerance =
-      this.maxQueueSize && typeof options?.queueTolerance !== 'undefined'
+      this.maxQueueSize && options?.queueTolerance !== undefined
         ? this.maxQueueSize * options.queueTolerance
         : 1;
     if (queueSize >= maxQueueTolerance) {

diff --git a/src/client/broker/transport/types.ts b/src/client/broker/transport/types.ts
@@ -1,5 +1,5 @@
 import { Dispatcher } from 'undici';
-import { IPinotPoolStats } from '../types';
+import { IPinotPoolStats, TQueueTolerancePredefined } from '../types';
 
 /**
  * Pinot broker transport config options
@@ -76,7 +76,8 @@ export interface IBrokerTransportRequestOptions
   > {
   options?:
     | {
-        queueTolerance?: number | undefined;
+        // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
+        queueTolerance?: TQueueTolerancePredefined | number | undefined;
       }
     | undefined;
 }

diff --git a/src/client/broker/types.ts b/src/client/broker/types.ts
@@ -237,7 +237,10 @@ export const enum EBrokerErrorCode {
   UNKNOWN,
 }
 
-type QueueTolerancePredefined =
+/**
+ * Predefined queue tolerance values.
+ */
+export type TQueueTolerancePredefined =
   | 0
   | 0.1
   | 0.2
@@ -315,7 +318,7 @@ export interface IPinotQueryOptions {
    *
    * @defaultValue 1
    */
-  queueTolerance?: QueueTolerancePredefined | number;
+  queueTolerance?: TQueueTolerancePredefined | number;
 }
 
 /**