basalt / search-elasticsearch/src / ElasticsearchDriverOptions

Interface: ElasticsearchDriverOptions

Defined in: search-elasticsearch/src/index.ts:34

Properties

apiKey?

> optional apiKey?: string

Defined in: search-elasticsearch/src/index.ts:38

API key → Authorization: ApiKey <key>.

---

fetch?

> optional fetch?: FetchLike

Defined in: search-elasticsearch/src/index.ts:51

Injected fetch. Defaults to the global fetch.

---

indexPrefix?

> optional indexPrefix?: string

Defined in: search-elasticsearch/src/index.ts:43

Prefix prepended to every index name (namespacing / env separation).

---

node

> node: string

Defined in: search-elasticsearch/src/index.ts:36

Cluster base URL, e.g. http://localhost:9200.

---

password?

> optional password?: string

Defined in: search-elasticsearch/src/index.ts:41

---

refresh?

> optional refresh?: boolean | "wait_for"

Defined in: search-elasticsearch/src/index.ts:49

Make writes visible before the request resolves. 'wait_for' (or true) is handy in dev/tests; leave false in production for throughput and let the refresh interval handle visibility.

---

username?

> optional username?: string

Defined in: search-elasticsearch/src/index.ts:40

Basic auth (alternative to apiKey).