Opensearch dashboards.legacyopensearcherrorhelpers

Home > opensearch-dashboards > LegacyOpenSearchErrorHelpers

LegacyOpenSearchErrorHelpers class

Helpers for working with errors returned from the OpenSearch service.Since the internal data of errors are subject to change, consumers of the OpenSearch service should always use these helpers to classify errors instead of checking error internals such as body.error.header[WWW-Authenticate]

Signature:

export declare class LegacyOpenSearchErrorHelpers 

Example

Handle errors

try {
  await client.asScoped(request).callAsCurrentUser(...);
} catch (err) {
  if (OpenSearchErrorHelpers.isNotAuthorizedError(err)) {
    const authHeader = err.output.headers['WWW-Authenticate'];
  }

Methods

Method	Modifiers	Description
decorateNotAuthorizedError(error, reason)	static
isNotAuthorizedError(error)	static