From 0fcbe29c6b8c564e6c23ab6a19fb38dc9791e622 Mon Sep 17 00:00:00 2001
From: Eric Peterson <ericpeterson@spotify.com>
Date: Tue, 10 Jan 2023 11:34:11 +0100
Subject: [PATCH] Clarify typeguard usage

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
---
 .../src/engines/ElasticSearchSearchEngine.ts                    | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
index c47cc35c47..9edad973de 100644
--- a/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
+++ b/plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts
@@ -180,6 +180,8 @@ export class ElasticSearchSearchEngine implements SearchEngine {
    * import { Client } from '@elastic/elasticsearch';
    *
    * const client = searchEngine.newClient<Client>(options => {
+   *   // This typeguard ensures options are compatible with either OpenSearch
+   *   // or Elasticsearch client constructors.
    *   if (!isOpenSearchCompatible(options)) {
    *     return new Client(options);
    *   }