Updated typings (#819)

elastic · Apr 17, 2019 · d4f4b47 · d4f4b47
1 parent cfd4e70
commit d4f4b47
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 7 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -27,7 +27,8 @@ import Transport, {
   TransportRequestParams,
   TransportRequestOptions,
   nodeFilterFn,
-  nodeSelectorFn
+  nodeSelectorFn,
+  TransportRequestCallback
 } from './lib/Transport';
 import Connection, { AgentOptions, agentFn } from './lib/Connection';
 import ConnectionPool, { ResurrectEvent } from './lib/ConnectionPool';
@@ -38,12 +39,18 @@ import * as errors from './lib/errors';
 declare type anyObject = {
   [key: string]: any;
 };
-declare type callbackFn = (err: Error | null, result: ApiResponse) => void;
 
-interface ApiMethod<T> {
-  (callback?: callbackFn): any;
-  (params: T, callback?: callbackFn): any;
-  (params: T, options: TransportRequestOptions, callback?: callbackFn): any;
+declare type callbackFn<T> = (err: Error | null, result: ApiResponse<T>) => void;
+
+interface ApiMethod<TParams, TBody = any> {
+  // Promise API
+  (): Promise<ApiResponse<TBody>>;
+  (params: TParams): Promise<ApiResponse<TBody>>;
+  (params: TParams, options: TransportRequestOptions): Promise<ApiResponse<TBody>>;
+  // Callback API
+  (callback: callbackFn<TBody>): TransportRequestCallback;
+  (params: TParams, callback: callbackFn<TBody>): TransportRequestCallback;
+  (params: TParams, options: TransportRequestOptions, callback: callbackFn<TBody>): TransportRequestCallback;
 }
 
 // Extend API
@@ -570,5 +577,6 @@ export {
   RequestEvent,
   ResurrectEvent,
   RequestParams,
+  ClientOptions,
   ClientExtendsCallbackOptions
 };
diff --git a/lib/Transport.d.ts b/lib/Transport.d.ts
@@ -96,6 +96,10 @@ export interface TransportRequestOptions {
   warnings?: [string];
 }
 
+export interface TransportRequestCallback {
+  abort: () => void;
+}
+
 export default class Transport {
   static sniffReasons: {
     SNIFF_ON_START: string;
@@ -117,7 +121,8 @@ export default class Transport {
   _nextSniff: number;
   _isSniffing: boolean;
   constructor(opts: TransportOptions);
-  request(params: TransportRequestParams, options: TransportRequestOptions, callback: (err: Error | null, result: ApiResponse) => void): any;
+  request(params: TransportRequestParams, options?: TransportRequestOptions): Promise<ApiResponse>;
+  request(params: TransportRequestParams, options?: TransportRequestOptions, callback?: (err: Error | null, result: ApiResponse) => void): TransportRequestCallback;
   getConnection(): Connection | null;
   sniff(callback?: (...args: any[]) => void): void;
 }