basalt / search/src / SearchPluginOptions

Interface: SearchPluginOptions

Defined in: search/src/plugin.ts:45

Properties

driver?

> optional driver?: SearchDriver

Defined in: search/src/plugin.ts:46

---

failOnRegisterError?

> optional failOnRegisterError?: boolean

Defined in: search/src/plugin.ts:57

Throw if an index fails to register at boot. Default false: a search backend that's down or misconfigured logs a warning and the app boots anyway (search stays degraded until the backend is reachable), so an outage never blocks unrelated work — including CLI commands that don't use search.

---

indexes?

> optional indexes?: IndexDefinition[]

Defined in: search/src/plugin.ts:48

Indexes to register with the driver at boot.

---

maxLimit?

> optional maxLimit?: number

Defined in: search/src/plugin.ts:62

Largest limit one search may ask for; above it search() throws SearchPaginationError (400). Default 1000.

---

maxOffset?

> optional maxOffset?: number

Defined in: search/src/plugin.ts:67

Largest offset one search may ask for; above it search() throws SearchPaginationError (400). Default 10000.

---

maxScan?

> optional maxScan?: number

Defined in: search/src/plugin.ts:72

Ceiling on the driver rows one authorized search (authorize hook) may scan; a per-call maxScan may only lower it. Default 10000.

---

sync?

> optional sync?: SyncRule<string>[]

Defined in: search/src/plugin.ts:50

Rules keeping indexes in sync with domain hooks.