Meilisearch JS / index / SearchMetadata

Type Alias: SearchMetadata

SearchMetadata = object

Defined in: src/types/search-rules.ts:190

Experimental

Search metadata included when Meili-Include-Metadata is true

See

https://www.meilisearch.com/docs/reference/api/search/search-with-post

Properties

indexUid

indexUid: string

Defined in: src/types/search-rules.ts:201

UID of the index that was searched

---

inlineRuleConditionOutcomes?

optional inlineRuleConditionOutcomes?: InlineRuleConditionOutcomes

Defined in: src/types/search-rules.ts:207

Condition check for the inline rule sent with the query

---

primaryKey?

optional primaryKey?: string

Defined in: src/types/search-rules.ts:203

Primary key of the index

---

query?

optional query?: string

Defined in: src/types/search-rules.ts:197

Query string

Present for a federated multi-search query that is not a placeholder search.

---

queryUid

queryUid: string

Defined in: src/types/search-rules.ts:199

Unique identifier of the query

---

remote?

optional remote?: string

Defined in: src/types/search-rules.ts:205

Remote that processed the query