Skip to main content

isOpenSearchCompatible()

Home > @backstage/plugin-search-backend-module-elasticsearch > isOpenSearchCompatible

Typeguard to differentiate ElasticSearch client options which are compatible with OpenSearch vs. ElasticSearch clients. Useful when calling the ElasticSearchSearchEngine.newClient() method.

Signature:

isOpenSearchCompatible: (opts: ElasticSearchClientOptions) => opts is OpenSearchElasticSearchClientOptions

Parameters

Parameter

Type

Description

opts

ElasticSearchClientOptions

**Returns:**

opts is OpenSearchElasticSearchClientOptions