Meilisearch JS / index / Settings

Type Alias: Settings

Settings = object

Defined in: src/types/types.ts:736

Properties

dictionary?

optional dictionary?: Dictionary

Defined in: src/types/types.ts:750

---

displayedAttributes?

optional displayedAttributes?: DisplayedAttributes

Defined in: src/types/types.ts:741

---

distinctAttribute?

optional distinctAttribute?: DistinctAttribute

Defined in: src/types/types.ts:738

---

embedders?

optional embedders?: Embedders

Defined in: src/types/types.ts:752

---

faceting?

optional faceting?: Faceting

Defined in: src/types/types.ts:746

---

facetSearch?

optional facetSearch?: boolean

Defined in: src/types/types.ts:761

Enable facet searching on all the filters of an index (requires Meilisearch 1.12.0 or later)

---

filterableAttributes?

optional filterableAttributes?: FilterableAttributes

Defined in: src/types/types.ts:737

---

foreignKeys?

optional foreignKeys?: ForeignKeys

Defined in: src/types/types.ts:755

---

localizedAttributes?

optional localizedAttributes?: LocalizedAttributes

Defined in: src/types/types.ts:754

---

nonSeparatorTokens?

optional nonSeparatorTokens?: NonSeparatorTokens

Defined in: src/types/types.ts:749

---

pagination?

optional pagination?: PaginationSettings

Defined in: src/types/types.ts:747

---

prefixSearch?

optional prefixSearch?: "indexingTime" | "disabled"

Defined in: src/types/types.ts:766

Enable the ability to search a word by prefix on an index (requires Meilisearch 1.12.0 or later)

---

proximityPrecision?

optional proximityPrecision?: ProximityPrecision

Defined in: src/types/types.ts:751

---

rankingRules?

optional rankingRules?: RankingRules

Defined in: src/types/types.ts:742

---

searchableAttributes?

optional searchableAttributes?: SearchableAttributes

Defined in: src/types/types.ts:740

---

searchCutoffMs?

optional searchCutoffMs?: SearchCutoffMs

Defined in: src/types/types.ts:753

---

separatorTokens?

optional separatorTokens?: SeparatorTokens

Defined in: src/types/types.ts:748

---

sortableAttributes?

optional sortableAttributes?: SortableAttributes

Defined in: src/types/types.ts:739

---

stopWords?

optional stopWords?: StopWords

Defined in: src/types/types.ts:743

---

synonyms?

optional synonyms?: Synonyms

Defined in: src/types/types.ts:744

---

typoTolerance?

optional typoTolerance?: TypoTolerance

Defined in: src/types/types.ts:745