@terascope/opensearch-client / client/create-client

client/create-client

Functions

createClient()

createClient(config, logger?): Promise<{ client: Client; log: () => Logger; }>

Defined in: opensearch-client/src/client/create-client.ts:17

creates an opensearch or elasticsearch client depending on the configuration

Parameters

Parameter	Type
config	ClientConfig
logger	Logger

Returns

Promise<{ client: Client; log: () => Logger; }>

---

formatClientConfig()

formatClientConfig(config, logger): ClientConfig

Defined in: opensearch-client/src/client/create-client.ts:50

Validates and formats the client configuration.

Ensures that:

• Both username and password are set if defined
• auth and username/password are not both set
• If caCertificate is set, warns if config.node is not https.

Parameters

Parameter	Type	Description
config	ClientConfig	The original client configuration.
logger	Logger	A Bunyan logger.

Returns

ClientConfig

A normalized and validated OpenSearch ClientConfig.

Throws

An error if configuration validation fails.

---

getBaseClient()

getBaseClient(clientMetadata, config, logger?): Promise<Client | Client | Client>

Defined in: opensearch-client/src/client/create-client.ts:172

Parameters

Parameter	Type
clientMetadata	ClientMetadata
config	ClientConfig
logger	Logger

Returns

Promise<Client | Client | Client>