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

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: SearchService

internal.internal.SearchService

Hierarchy

• AbstractSearchService

  ↳ SearchService

Properties

isDefault

• isDefault: boolean

Overrides

AbstractSearchService.isDefault

Defined in

packages/medusa/dist/services/search.d.ts:9

---

logger_

• Protected Readonly logger_: Logger

Defined in

packages/medusa/dist/services/search.d.ts:10

---

options_

• Protected Readonly options_: Record<string, unknown>

Overrides

AbstractSearchService.options_

Defined in

packages/medusa/dist/services/search.d.ts:11

Accessors

options

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

Returns

Record<string, unknown>

Inherited from

AbstractSearchService.options

Defined in

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

Methods

addDocuments

▸ addDocuments(indexName, documents, type): Promise<void>

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

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.addDocuments

Defined in

packages/medusa/dist/services/search.d.ts:15

---

createIndex

▸ createIndex(indexName, options): Promise<void>

Used to create an index

Parameters

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

Returns

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.createIndex

Defined in

packages/medusa/dist/services/search.d.ts:13

---

deleteAllDocuments

▸ deleteAllDocuments(indexName): Promise<void>

Used to delete all documents

Parameters

Name	Type	Description
indexName	string	the index name

Returns

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.deleteAllDocuments

Defined in

packages/medusa/dist/services/search.d.ts:18

---

deleteDocument

▸ deleteDocument(indexName, document_id): Promise<void>

Used to delete document

Parameters

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

Returns

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.deleteDocument

Defined in

packages/medusa/dist/services/search.d.ts:17

---

getIndex

▸ getIndex(indexName): Promise<void>

Used to get an index

Parameters

Name	Type	Description
indexName	string	the index name.

Returns

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.getIndex

Defined in

packages/medusa/dist/services/search.d.ts:14

---

replaceDocuments

▸ replaceDocuments(indexName, documents, type): Promise<void>

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

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.replaceDocuments

Defined in

packages/medusa/dist/services/search.d.ts:16

---

search

▸ search(indexName, query, options): Promise<{ hits: unknown[] }>

Used to search for a document in an index

Parameters

Name	Type	Description
indexName	string	the index name
query	unknown	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

Promise<{ hits: unknown[] }>

returns response from search engine provider

Overrides

AbstractSearchService.search

Defined in

packages/medusa/dist/services/search.d.ts:19

---

updateSettings

▸ updateSettings(indexName, settings): Promise<void>

Used to update the settings of an index

Parameters

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

Returns

Promise<void>

returns response from search engine provider

Overrides

AbstractSearchService.updateSettings

Defined in

packages/medusa/dist/services/search.d.ts:22