Class Index<T>

Type Parameters

T extends RecordAny = RecordAny

Index

Constructors

Properties

createdAt httpRequest primaryKey tasks uid updatedAt

Methods

addDocuments addDocumentsFromString addDocumentsInBatches delete deleteAllDocuments deleteDocument deleteDocuments fetchInfo fetchPrimaryKey getDictionary getDisplayedAttributes getDistinctAttribute getDocument getDocuments getEmbedders getFaceting getFacetSearch getFilterableAttributes getLocalizedAttributes getNonSeparatorTokens getPagination getPrefixSearch getProximityPrecision getRankingRules getRawInfo getSearchableAttributes getSearchCutoffMs getSeparatorTokens getSettings getSortableAttributes getStats getStopWords getSynonyms getTypoTolerance resetDictionary resetDisplayedAttributes resetDistinctAttribute resetEmbedders resetFaceting resetFacetSearch resetFilterableAttributes resetLocalizedAttributes resetNonSeparatorTokens resetPagination resetPrefixSearch resetProximityPrecision resetRankingRules resetSearchableAttributes resetSearchCutoffMs resetSeparatorTokens resetSettings resetSortableAttributes resetStopWords resetSynonyms resetTypoTolerance search searchForFacetValues searchGet searchSimilarDocuments update updateDictionary updateDisplayedAttributes updateDistinctAttribute updateDocuments updateDocumentsByFunction updateDocumentsFromString updateDocumentsInBatches updateEmbedders updateFaceting updateFacetSearch updateFilterableAttributes updateLocalizedAttributes updateNonSeparatorTokens updatePagination updatePrefixSearch updateProximityPrecision updateRankingRules updateSearchableAttributes updateSearchCutoffMs updateSeparatorTokens updateSettings updateSortableAttributes updateStopWords updateSynonyms updateTypoTolerance create

Constructors

constructor

new Index<T extends RecordAny = RecordAny>(
    config: Config,
    uid: string,
    primaryKey?: string,
): Index<T>
Type Parameters
- T extends RecordAny = RecordAny
Parameters
- config: Config
  Request configuration options
- uid: string
  UID of the index
- OptionalprimaryKey: string
  Primary Key of the index
Returns Index<T>
- Defined in src/indexes.ts:75

Properties

createdAt

createdAt: undefined | Date

httpRequest

httpRequest: HttpRequests

primaryKey

primaryKey: undefined | string

tasks

tasks: TaskClient

uid

uid: string

updatedAt

updatedAt: undefined | Date

Methods

addDocuments

addDocuments(documents: T[], options?: DocumentOptions): EnqueuedTaskPromise
Add or replace multiples documents to an index
Parameters
- documents: T[]
  Array of Document objects to add/replace
- Optionaloptions: DocumentOptions
  Options on document addition
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:348

addDocumentsFromString

addDocumentsFromString(
    documents: string,
    contentType: ContentType,
    queryParams?: RawDocumentAdditionOptions,
): EnqueuedTaskPromise
Add or replace multiples documents in a string format to an index. It only supports csv, ndjson and json formats.
Parameters
- documents: string
  Documents provided in a string to add/replace
- contentType: ContentType
  Content type of your document: 'text/csv'|'application/x-ndjson'|'application/json'
- OptionalqueryParams: RawDocumentAdditionOptions
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:366

addDocumentsInBatches

addDocumentsInBatches(
    documents: T[],
    batchSize?: number,
    options?: DocumentOptions,
): EnqueuedTaskPromise[]
Add or replace multiples documents to an index in batches
Parameters
- documents: T[]
  Array of Document objects to add/replace
- batchSize: number = 1000
  Size of the batch
- Optionaloptions: DocumentOptions
  Options on document addition
Returns EnqueuedTaskPromise[]
Promise containing array of enqueued task objects for each batch
- Defined in src/indexes.ts:387

delete

delete(): EnqueuedTaskPromise
Delete an index.

Returns EnqueuedTaskPromise
Promise which resolves when index is deleted successfully
- Defined in src/indexes.ts:270

deleteAllDocuments

deleteAllDocuments(): EnqueuedTaskPromise
Delete all documents of an index

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:512

deleteDocument

deleteDocument(documentId: string | number): EnqueuedTaskPromise
Delete one document
Parameters
- documentId: string | number
  Id of Document to delete
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:474

deleteDocuments

deleteDocuments(
params: DocumentsDeletionQuery | DocumentsIds,
): EnqueuedTaskPromise
Delete multiples documents of an index.
Parameters
- params: DocumentsDeletionQuery | DocumentsIds
  Params value can be:
  
  DocumentsDeletionQuery: An object containing the parameters to customize your document deletion. Only available in Meilisearch v1.2 and newer
  
  DocumentsIds: An array of document ids to delete
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:491

fetchInfo

fetchInfo(): Promise<Index<T>>
Fetch and update Index information.

Returns Promise<Index<T>>
Promise to the current Index object with updated information
- Defined in src/indexes.ts:214

fetchPrimaryKey

fetchPrimaryKey(): Promise<undefined | string>
Get Primary Key.

Returns Promise<undefined | string>
Promise containing the Primary Key of the index
- Defined in src/indexes.ts:224

getDictionary

getDictionary(): Promise<string[]>
Get the dictionary settings of a Meilisearch index.

Returns Promise<string[]>
Promise containing the dictionary settings
- Defined in src/indexes.ts:1112

getDisplayedAttributes

getDisplayedAttributes(): Promise<string[]>
Get the displayed-attributes

Returns Promise<string[]>
Promise containing array of displayed-attributes
- Defined in src/indexes.ts:911

getDistinctAttribute

getDistinctAttribute(): Promise<DistinctAttribute>
Get the distinct-attribute

Returns Promise<DistinctAttribute>
Promise containing the distinct-attribute of the index
- Defined in src/indexes.ts:744

getDocument

getDocument<D extends RecordAny = T>(
documentId: string | number,
parameters?: DocumentQuery<T>,
): Promise<D>
Get one document
Type Parameters
- D extends RecordAny = T
Parameters
- documentId: string | number
  Document ID
- Optionalparameters: DocumentQuery<T>
  Parameters applied on a document
Returns Promise<D>
Promise containing Document response
- Defined in src/indexes.ts:327

getDocuments

getDocuments<D extends RecordAny = T>(
params?: DocumentsQuery<D>,
): Promise<ResourceResults<D[]>>
Get documents of an index.
Type Parameters
- D extends RecordAny = T
Parameters
- Optionalparams: DocumentsQuery<D>
  Parameters to browse the documents. Parameters can contain the filter field only available in Meilisearch v1.2 and newer
Returns Promise<ResourceResults<D[]>>
Promise containing the returned documents
- Defined in src/indexes.ts:302

getEmbedders

getEmbedders(): Promise<Embedders>
Get the embedders settings of a Meilisearch index.

Returns Promise<Embedders>
Promise containing the embedders settings
- Defined in src/indexes.ts:1193

getFaceting

getFaceting(): Promise<Faceting>
Get the faceting settings.

Returns Promise<Faceting>
Promise containing object of faceting index settings
- Defined in src/indexes.ts:993

getFacetSearch

getFacetSearch(): Promise<boolean>
Get the facet search settings.

Returns Promise<boolean>
Promise containing object of facet search settings
- Defined in src/indexes.ts:1312

getFilterableAttributes

getFilterableAttributes(): Promise<FilterableAttributes>
Get the filterable-attributes

Returns Promise<FilterableAttributes>
Promise containing an array of filterable-attributes
- Defined in src/indexes.ts:785

getLocalizedAttributes

getLocalizedAttributes(): Promise<LocalizedAttributes>
Get the localized attributes settings.

Returns Promise<LocalizedAttributes>
Promise containing object of localized attributes settings
- Defined in src/indexes.ts:1271

getNonSeparatorTokens

getNonSeparatorTokens(): Promise<string[]>
Get the list of all non-separator tokens.

Returns Promise<string[]>
Promise containing array of non-separator tokens
- Defined in src/indexes.ts:1071

getPagination

getPagination(): Promise<PaginationSettings>
Get the pagination settings.

Returns Promise<PaginationSettings>
Promise containing object of pagination settings
- Defined in src/indexes.ts:587

getPrefixSearch

getPrefixSearch(): Promise<PrefixSearch>
Get the prefix search settings.

Returns Promise<PrefixSearch>
Promise containing object of prefix search settings
- Defined in src/indexes.ts:1351

getProximityPrecision

getProximityPrecision(): Promise<ProximityPrecision>
Get the proximity precision settings of a Meilisearch index.

Returns Promise<ProximityPrecision>
Promise containing the proximity precision settings
- Defined in src/indexes.ts:1151

getRankingRules

getRankingRules(): Promise<string[]>
Get the list of all ranking-rules

Returns Promise<string[]>
Promise containing array of ranking-rules
- Defined in src/indexes.ts:704

getRawInfo

getRawInfo(): Promise<IndexObject>
Get index information.

Returns Promise<IndexObject>
Promise containing index information
- Defined in src/indexes.ts:199

getSearchableAttributes

getSearchableAttributes(): Promise<string[]>
Get the searchable-attributes

Returns Promise<string[]>
Promise containing array of searchable-attributes
- Defined in src/indexes.ts:869

getSearchCutoffMs

getSearchCutoffMs(): Promise<SearchCutoffMs>
Get the SearchCutoffMs settings.

Returns Promise<SearchCutoffMs>
Promise containing object of SearchCutoffMs settings
- Defined in src/indexes.ts:1232

getSeparatorTokens

getSeparatorTokens(): Promise<string[]>
Get the list of all separator tokens.

Returns Promise<string[]>
Promise containing array of separator tokens
- Defined in src/indexes.ts:1032

getSettings

getSettings(): Promise<Settings>
Retrieve all settings

Returns Promise<Settings>
Promise containing Settings object
- Defined in src/indexes.ts:548

getSortableAttributes

getSortableAttributes(): Promise<string[]>
Get the sortable-attributes

Returns Promise<string[]>
Promise containing array of sortable-attributes
- Defined in src/indexes.ts:827

getStats

getStats(): Promise<IndexStats>
Get stats of an index

Returns Promise<IndexStats>
Promise containing object with stats of the index
- Defined in src/indexes.ts:285

getStopWords

getStopWords(): Promise<string[]>
Get the list of all stop-words

Returns Promise<string[]>
Promise containing array of stop-words
- Defined in src/indexes.ts:665

getSynonyms

getSynonyms(): Promise<Record<string, string[]>>
Get the list of all synonyms

Returns Promise<Record<string, string[]>>
Promise containing record of synonym mappings
- Defined in src/indexes.ts:626

getTypoTolerance

getTypoTolerance(): Promise<TypoTolerance>
Get the typo tolerance settings.

Returns Promise<TypoTolerance>
Promise containing the typo tolerance settings.
- Defined in src/indexes.ts:953

resetDictionary

resetDictionary(): EnqueuedTaskPromise
Reset the dictionary settings to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1136

resetDisplayedAttributes

resetDisplayedAttributes(): EnqueuedTaskPromise
Reset the displayed-attributes.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:938

resetDistinctAttribute

resetDistinctAttribute(): EnqueuedTaskPromise
Reset the distinct-attribute.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:770

resetEmbedders

resetEmbedders(): EnqueuedTaskPromise
Reset the embedders settings to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1217

resetFaceting

resetFaceting(): EnqueuedTaskPromise
Reset the faceting settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1017

resetFacetSearch

resetFacetSearch(): EnqueuedTaskPromise
Reset the facet search settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1336

resetFilterableAttributes

resetFilterableAttributes(): EnqueuedTaskPromise
Reset the filterable-attributes.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:812

resetLocalizedAttributes

resetLocalizedAttributes(): EnqueuedTaskPromise
Reset the localized attributes settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1297

resetNonSeparatorTokens

resetNonSeparatorTokens(): EnqueuedTaskPromise
Reset the non-separator tokens list to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1097

resetPagination

resetPagination(): EnqueuedTaskPromise
Reset the pagination settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:611

resetPrefixSearch

resetPrefixSearch(): EnqueuedTaskPromise
Reset the prefix search settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1375

resetProximityPrecision

resetProximityPrecision(): EnqueuedTaskPromise
Reset the proximity precision settings to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1178

resetRankingRules

resetRankingRules(): EnqueuedTaskPromise
Reset the ranking rules list to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:729

resetSearchableAttributes

resetSearchableAttributes(): EnqueuedTaskPromise
Reset the searchable-attributes.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:896

resetSearchCutoffMs

resetSearchCutoffMs(): EnqueuedTaskPromise
Reset the SearchCutoffMs settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1256

resetSeparatorTokens

resetSeparatorTokens(): EnqueuedTaskPromise
Reset the separator tokens list to its default value

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1056

resetSettings

resetSettings(): EnqueuedTaskPromise
Reset settings.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:572

resetSortableAttributes

resetSortableAttributes(): EnqueuedTaskPromise
Reset the sortable-attributes.

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:854

resetStopWords

resetStopWords(): EnqueuedTaskPromise
Reset the stop-words list to be empty again

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:689

resetSynonyms

resetSynonyms(): EnqueuedTaskPromise
Reset the synonym list to be empty again

Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:650

resetTypoTolerance

resetTypoTolerance(): EnqueuedTaskPromise
Reset the typo tolerance settings.

Returns EnqueuedTaskPromise
Promise containing object of the enqueued update
- Defined in src/indexes.ts:978

search

search<D extends RecordAny = T, S extends SearchParams = SearchParams>(
    query?: null | string,
    options?: S,
    extraRequestInit?: ExtraRequestInit,
): Promise<SearchResponse<D, S>>
Search for documents into an index
Type Parameters
- D extends RecordAny = T
- S extends SearchParams = SearchParams
Parameters
- Optionalquery: null | string
  Query string
- Optionaloptions: S
  Search options
- OptionalextraRequestInit: ExtraRequestInit
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
- Defined in src/indexes.ts:98

searchForFacetValues

searchForFacetValues(
params: SearchForFacetValuesParams,
extraRequestInit?: ExtraRequestInit,
): Promise<SearchForFacetValuesResponse>
Search for facet values
Parameters
- params: SearchForFacetValuesParams
  Parameters used to search on the facets
- OptionalextraRequestInit: ExtraRequestInit
Returns Promise<SearchForFacetValuesResponse>
Promise containing the search response
- Defined in src/indexes.ts:163

searchGet

searchGet<D extends RecordAny = T, S extends SearchParams = SearchParams>(
    query?: null | string,
    options?: S,
    extraRequestInit?: ExtraRequestInit,
): Promise<SearchResponse<D, S>>
Search for documents into an index using the GET method
Type Parameters
- D extends RecordAny = T
- S extends SearchParams = SearchParams
Parameters
- Optionalquery: null | string
  Query string
- Optionaloptions: S
  Search options
- OptionalextraRequestInit: ExtraRequestInit
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
- Defined in src/indexes.ts:118

searchSimilarDocuments

searchSimilarDocuments<
    D extends RecordAny = T,
    S extends SearchParams = SearchParams,
>(
    params: SearchSimilarDocumentsParams,
): Promise<SearchResponse<D, S>>
Search for similar documents
Type Parameters
- D extends RecordAny = T
- S extends SearchParams = SearchParams
Parameters
- params: SearchSimilarDocumentsParams
  Parameters used to search for similar documents
Returns Promise<SearchResponse<D, S>>
Promise containing the search response
- Defined in src/indexes.ts:180

update

update(data?: IndexOptions): EnqueuedTaskPromise
Update an index.
Parameters
- Optionaldata: IndexOptions
  Data to update
Returns EnqueuedTaskPromise
Promise to the current Index object with updated information
- Defined in src/indexes.ts:258

updateDictionary

updateDictionary(dictionary: Dictionary): EnqueuedTaskPromise
Update the dictionary settings. Overwrite the old settings.
Parameters
- dictionary: Dictionary
  Array that contains the new dictionary settings.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask or null
- Defined in src/indexes.ts:1124

updateDisplayedAttributes

updateDisplayedAttributes(
displayedAttributes: DisplayedAttributes,
): EnqueuedTaskPromise
Update the displayed-attributes.
Parameters
- displayedAttributes: DisplayedAttributes
  Array of strings that contains attributes of an index to display
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:924

updateDistinctAttribute

updateDistinctAttribute(
distinctAttribute: DistinctAttribute,
): EnqueuedTaskPromise
Update the distinct-attribute.
Parameters
- distinctAttribute: DistinctAttribute
  Field name of the distinct-attribute
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:756

updateDocuments

updateDocuments(
documents: Partial<T>[],
options?: DocumentOptions,
): EnqueuedTaskPromise
Add or update multiples documents to an index
Parameters
- documents: Partial<T>[]
  Array of Document objects to add/update
- Optionaloptions: DocumentOptions
  Options on document update
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:410

updateDocumentsByFunction

updateDocumentsByFunction(
options: UpdateDocumentsByFunctionOptions,
): EnqueuedTaskPromise
This is an EXPERIMENTAL feature, which may break without a major version. It's available after Meilisearch v1.10.

More info about the feature: https://github.com/orgs/meilisearch/discussions/762 More info about experimental features in general: https://www.meilisearch.com/docs/reference/api/experimental-features
Parameters
- options: UpdateDocumentsByFunctionOptions
  Object containing the function string and related options
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:530

updateDocumentsFromString

updateDocumentsFromString(
    documents: string,
    contentType: ContentType,
    queryParams?: RawDocumentAdditionOptions,
): EnqueuedTaskPromise
Add or update multiples documents in a string format to an index. It only supports csv, ndjson and json formats.
Parameters
- documents: string
  Documents provided in a string to add/update
- contentType: ContentType
  Content type of your document: 'text/csv'|'application/x-ndjson'|'application/json'
- OptionalqueryParams: RawDocumentAdditionOptions
  Options on raw document addition
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:455

updateDocumentsInBatches

updateDocumentsInBatches(
    documents: Partial<T>[],
    batchSize?: number,
    options?: DocumentOptions,
): EnqueuedTaskPromise[]
Add or update multiples documents to an index in batches
Parameters
- documents: Partial<T>[]
  Array of Document objects to add/update
- batchSize: number = 1000
  Size of the batch
- Optionaloptions: DocumentOptions
  Options on document update
Returns EnqueuedTaskPromise[]
Promise containing array of enqueued task objects for each batch
- Defined in src/indexes.ts:429

updateEmbedders

updateEmbedders(embedders: Embedders): EnqueuedTaskPromise
Update the embedders settings. Overwrite the old settings.
Parameters
- embedders: Embedders
  Object that contains the new embedders settings.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask or null
- Defined in src/indexes.ts:1205

updateFaceting

updateFaceting(faceting: Faceting): EnqueuedTaskPromise
Update the faceting settings.
Parameters
- faceting: Faceting
  Faceting index settings object
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1005

updateFacetSearch

updateFacetSearch(facetSearch: boolean): EnqueuedTaskPromise
Update the facet search settings.
Parameters
- facetSearch: boolean
  Boolean value
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1324

updateFilterableAttributes

updateFilterableAttributes(
filterableAttributes: FilterableAttributes,
): EnqueuedTaskPromise
Update the filterable-attributes.
Parameters
- filterableAttributes: FilterableAttributes
  Array of strings containing the attributes that can be used as filters at query time
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:798

updateLocalizedAttributes

updateLocalizedAttributes(
localizedAttributes: LocalizedAttributes,
): EnqueuedTaskPromise
Update the localized attributes settings.
Parameters
- localizedAttributes: LocalizedAttributes
  Localized attributes object
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1283

updateNonSeparatorTokens

updateNonSeparatorTokens(
nonSeparatorTokens: NonSeparatorTokens,
): EnqueuedTaskPromise
Update the list of non-separator tokens. Overwrite the old list.
Parameters
- nonSeparatorTokens: NonSeparatorTokens
  Array that contains non-separator tokens.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask or null
- Defined in src/indexes.ts:1083

updatePagination

updatePagination(pagination: PaginationSettings): EnqueuedTaskPromise
Update the pagination settings.
Parameters
- pagination: PaginationSettings
  Pagination object
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:599

updatePrefixSearch

updatePrefixSearch(prefixSearch: PrefixSearch): EnqueuedTaskPromise
Update the prefix search settings.
Parameters
- prefixSearch: PrefixSearch
  PrefixSearch value
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1363

updateProximityPrecision

updateProximityPrecision(
proximityPrecision: ProximityPrecision,
): EnqueuedTaskPromise
Update the proximity precision settings. Overwrite the old settings.
Parameters
- proximityPrecision: ProximityPrecision
  String that contains the new proximity precision settings.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask or null
- Defined in src/indexes.ts:1164

updateRankingRules

updateRankingRules(rankingRules: RankingRules): EnqueuedTaskPromise
Update the list of ranking-rules. Overwrite the old list.
Parameters
- rankingRules: RankingRules
  Array that contain ranking rules sorted by order of importance.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:717

updateSearchableAttributes

updateSearchableAttributes(
searchableAttributes: SearchableAttributes,
): EnqueuedTaskPromise
Update the searchable-attributes.
Parameters
- searchableAttributes: SearchableAttributes
  Array of strings that contains searchable attributes sorted by order of importance(most to least important)
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:882

updateSearchCutoffMs

updateSearchCutoffMs(searchCutoffMs: SearchCutoffMs): EnqueuedTaskPromise
Update the SearchCutoffMs settings.
Parameters
- searchCutoffMs: SearchCutoffMs
  Object containing SearchCutoffMsSettings
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:1244

updateSeparatorTokens

updateSeparatorTokens(separatorTokens: SeparatorTokens): EnqueuedTaskPromise
Update the list of separator tokens. Overwrite the old list.
Parameters
- separatorTokens: SeparatorTokens
  Array that contains separator tokens.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask or null
- Defined in src/indexes.ts:1044

updateSettings

updateSettings(settings: Settings): EnqueuedTaskPromise
Update all settings Any parameters not provided will be left unchanged.
Parameters
- settings: Settings
  Object containing parameters with their updated values
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:560

updateSortableAttributes

updateSortableAttributes(
sortableAttributes: SortableAttributes,
): EnqueuedTaskPromise
Update the sortable-attributes.
Parameters
- sortableAttributes: SortableAttributes
  Array of strings containing the attributes that can be used to sort search results at query time
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:840

updateStopWords

updateStopWords(stopWords: StopWords): EnqueuedTaskPromise
Update the list of stop-words. Overwrite the old list.
Parameters
- stopWords: StopWords
  Array of strings that contains the stop-words.
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:677

updateSynonyms

updateSynonyms(synonyms: Synonyms): EnqueuedTaskPromise
Update the list of synonyms. Overwrite the old list.
Parameters
- synonyms: Synonyms
  Mapping of synonyms with their associated words
Returns EnqueuedTaskPromise
Promise containing an EnqueuedTask
- Defined in src/indexes.ts:638

updateTypoTolerance

updateTypoTolerance(typoTolerance: TypoTolerance): EnqueuedTaskPromise
Update the typo tolerance settings.
Parameters
- typoTolerance: TypoTolerance
  Object containing the custom typo tolerance settings.
Returns EnqueuedTaskPromise
Promise containing object of the enqueued update
- Defined in src/indexes.ts:966

`Static`create

create(uid: string, options?: IndexOptions, config: Config): EnqueuedTaskPromise
Create an index.
Parameters
- uid: string
  Unique identifier of the Index
- options: IndexOptions = {}
  Index options
- config: Config
  Request configuration options
Returns EnqueuedTaskPromise
Newly created Index object
- Defined in src/indexes.ts:237

Class Index<T>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Index<T>

Properties

createdAt

httpRequest

primaryKey

tasks

uid

updatedAt

Methods

addDocuments

Parameters

Returns EnqueuedTaskPromise

addDocumentsFromString

Parameters

Returns EnqueuedTaskPromise

addDocumentsInBatches

Parameters

Returns EnqueuedTaskPromise[]

delete

Returns EnqueuedTaskPromise

deleteAllDocuments

Returns EnqueuedTaskPromise

deleteDocument

Parameters

Returns EnqueuedTaskPromise

deleteDocuments

Parameters

Returns EnqueuedTaskPromise

fetchInfo

Returns Promise<Index<T>>

fetchPrimaryKey

Returns Promise<undefined | string>

getDictionary

Returns Promise<string[]>

getDisplayedAttributes

Returns Promise<string[]>

getDistinctAttribute

Returns Promise<DistinctAttribute>

getDocument

Type Parameters

Parameters

Returns Promise<D>

getDocuments

Type Parameters

Parameters

Returns Promise<ResourceResults<D[]>>

getEmbedders

Returns Promise<Embedders>

getFaceting

Returns Promise<Faceting>

getFacetSearch

Returns Promise<boolean>

getFilterableAttributes

Returns Promise<FilterableAttributes>

getLocalizedAttributes

Returns Promise<LocalizedAttributes>

getNonSeparatorTokens

Returns Promise<string[]>

getPagination

Returns Promise<PaginationSettings>

getPrefixSearch

Returns Promise<PrefixSearch>

getProximityPrecision

Returns Promise<ProximityPrecision>

getRankingRules

Returns Promise<string[]>

getRawInfo

Returns Promise<IndexObject>

getSearchableAttributes

Returns Promise<string[]>