medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.AbstractSearchService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AbstractSearchService

internal.AbstractSearchService

Hierarchy

• AbstractSearchService

  ↳ SearchService

Implements

• ISearchService

Properties

isDefault

• Readonly Abstract isDefault: any

Defined in

packages/utils/dist/search/abstract-service.d.ts:3

---

options_

• Protected Readonly options_: Record<string, unknown>

Defined in

packages/utils/dist/search/abstract-service.d.ts:4

Accessors

options

• get options(): Record<string, unknown>

Returns

Record<string, unknown>

Implementation of

ISearchService.options

Defined in

packages/utils/dist/search/abstract-service.d.ts:5

Methods

addDocuments

▸ Abstract addDocuments(indexName, documents, type): unknown

Used to index documents by the search engine provider

Parameters

Name	Type	Description
indexName	string	the index name
documents	unknown	documents array to be indexed
type	string	of documents to be added (e.g: products, regions, orders, etc)

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.addDocuments

Defined in

packages/utils/dist/search/abstract-service.d.ts:9

---

createIndex

▸ Abstract createIndex(indexName, options): unknown

Used to create an index

Parameters

Name	Type	Description
indexName	string	the index name
options	unknown	the options

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.createIndex

Defined in

packages/utils/dist/search/abstract-service.d.ts:7

---

deleteAllDocuments

▸ Abstract deleteAllDocuments(indexName): unknown

Used to delete all documents

Parameters

Name	Type	Description
indexName	string	the index name

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.deleteAllDocuments

Defined in

packages/utils/dist/search/abstract-service.d.ts:12

---

deleteDocument

▸ Abstract deleteDocument(indexName, document_id): unknown

Used to delete document

Parameters

Name	Type	Description
indexName	string	the index name
document_id	string | number	the id of the document

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.deleteDocument

Defined in

packages/utils/dist/search/abstract-service.d.ts:11

---

getIndex

▸ Abstract getIndex(indexName): unknown

Used to get an index

Parameters

Name	Type	Description
indexName	string	the index name.

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.getIndex

Defined in

packages/utils/dist/search/abstract-service.d.ts:8

---

replaceDocuments

▸ Abstract replaceDocuments(indexName, documents, type): unknown

Used to replace documents

Parameters

Name	Type	Description
indexName	string	the index name.
documents	unknown	array of document objects that will replace existing documents
type	string	type of documents to be replaced (e.g: products, regions, orders, etc)

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.replaceDocuments

Defined in

packages/utils/dist/search/abstract-service.d.ts:10

---

search

▸ Abstract search(indexName, query, options): unknown

Used to search for a document in an index

Parameters

Name	Type	Description
indexName	string	the index name
query	null | string	the search query
options	unknown	any options passed to the request object other than the query and indexName - additionalOptions contain any provider specific options

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.search

Defined in

packages/utils/dist/search/abstract-service.d.ts:13

---

updateSettings

▸ Abstract updateSettings(indexName, settings): unknown

Used to update the settings of an index

Parameters

Name	Type	Description
indexName	string	the index name
settings	unknown	settings object

Returns

unknown

returns response from search engine provider

Implementation of

ISearchService.updateSettings

Defined in

packages/utils/dist/search/abstract-service.d.ts:14