[ILM] Add comments about legacy and new es js client

elastic · Oct 15, 2020 · 268d165 · 268d165
1 parent 92d703e
commit 268d165
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts b/src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts
@@ -24,6 +24,10 @@ interface EsErrorHandlerParams {
   error: ApiError;
   response: KibanaResponseFactory;
 }
+
+/*
+ * For errors returned by the new elasticsearch js client.
+ */
 export const handleEsError = ({ error, response }: EsErrorHandlerParams): IKibanaResponse => {
   // error.name is slightly better in terms of performance, since all errors now have name property
   if (error.name === 'ResponseError') {

diff --git a/src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts b/src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts
@@ -25,6 +25,10 @@ interface RequestError extends Error {
   statusCode?: number;
 }
 
+/*
+ * @deprecated
+ * Only works with legacy elasticsearch js client errors and will be removed after 7.x last
+ */
 export function isEsError(err: RequestError) {
   const isInstanceOfEsError = err instanceof esErrorsParent;
   const hasStatusCode = Boolean(err.statusCode);