ISearchService

Properties

optionsRecord<string, unknown>Required

Methods

addDocuments

**addDocuments**(indexName, documents, type): unknown

Used to index documents by the search engine provider

Parameters

indexNamestringRequired

the index name

documentsunknownRequired

documents array to be indexed

typestringRequired

of documents to be added (e.g: products, regions, orders, etc)

Returns

unknown

unknownunknown

returns response from search engine provider

---

createIndex

**createIndex**(indexName, options): unknown

Used to create an index

Parameters

indexNamestringRequired

the index name

optionsunknownRequired

the options

Returns

unknown

unknownunknown

returns response from search engine provider

---

deleteAllDocuments

**deleteAllDocuments**(indexName): unknown

Used to delete all documents

Parameters

indexNamestringRequired

the index name

Returns

unknown

unknownunknown

returns response from search engine provider

---

deleteDocument

**deleteDocument**(indexName, document_id): unknown

Used to delete document

Parameters

indexNamestringRequired

the index name

document_idstring | numberRequired

the id of the document

Returns

unknown

unknownunknown

returns response from search engine provider

---

getIndex

**getIndex**(indexName): unknown

Used to get an index

Parameters

indexNamestringRequired

the index name.

Returns

unknown

unknownunknown

returns response from search engine provider

---

replaceDocuments

**replaceDocuments**(indexName, documents, type): unknown

Used to replace documents

Parameters

indexNamestringRequired

the index name.

documentsunknownRequired

array of document objects that will replace existing documents

typestringRequired

type of documents to be replaced (e.g: products, regions, orders, etc)

Returns

unknown

unknownunknown

returns response from search engine provider

---

search

**search**(indexName, query, options): unknown

Used to search for a document in an index

Parameters

indexNamestringRequired

the index name

querynull | stringRequired

the search query

optionsunknownRequired

any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options

Returns

unknown

unknownunknown

returns response from search engine provider

---

updateSettings

**updateSettings**(indexName, settings): unknown

Used to update the settings of an index

Parameters

indexNamestringRequired

the index name

settingsunknownRequired

settings object

Returns

unknown

unknownunknown

returns response from search engine provider