Skip to content
dbx tools

Variable: searchClientConfigSchema

const searchClientConfigSchema: ZodObject<{ basePath: ZodString; defaultIndex: ZodOptional<ZodString>; indexes: ZodArray<ZodObject<{ alias: ZodOptional<ZodString>; columns: ZodOptional<ZodArray<ZodString>>; isDefault: ZodOptional<ZodBoolean>; name: ZodString; primaryKey: ZodOptional<ZodString>; }, $strip>>; pageSize: ZodNumber; }, $strip>

Schema for the plugin’s client config surfaced to a UI.

searchClientConfig fields

Section titled “searchClientConfig fields”
  • indexes: Indexes the search UI may query.
  • defaultIndex (optional): The index a search box selects by default.
  • pageSize: Default number of hits a search returns.
  • basePath: Base path the search routes are mounted under (e.g. /api/search).