Files
medusa-store/www/apps/docs/content/references/services/classes/SearchService.md
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00

5.0 KiB

Class: SearchService

Hierarchy

  • AbstractSearchService

    SearchService

Constructors

constructor

new SearchService(__namedParameters, options)

Parameters

Name Type
__namedParameters InjectedDependencies
options any

Overrides

AbstractSearchService.constructor

Defined in

medusa/src/services/search.ts:16

Properties

isDefault

isDefault: boolean = true

Overrides

AbstractSearchService.isDefault

Defined in

medusa/src/services/search.ts:11


logger_

Protected Readonly logger_: Logger

Defined in

medusa/src/services/search.ts:13


options_

Protected Readonly options_: Record<string, unknown>

Overrides

AbstractSearchService.options_

Defined in

medusa/src/services/search.ts:14

Accessors

options

get options(): Record<string, unknown>

Returns

Record<string, unknown>

Inherited from

AbstractSearchService.options

Defined in

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

Methods

addDocuments

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

Parameters

Name Type
indexName string
documents unknown
type string

Returns

Promise<void>

Overrides

AbstractSearchService.addDocuments

Defined in

medusa/src/services/search.ts:40


createIndex

createIndex(indexName, options): Promise<void>

Parameters

Name Type
indexName string
options unknown

Returns

Promise<void>

Overrides

AbstractSearchService.createIndex

Defined in

medusa/src/services/search.ts:28


deleteAllDocuments

deleteAllDocuments(indexName): Promise<void>

Parameters

Name Type
indexName string

Returns

Promise<void>

Overrides

AbstractSearchService.deleteAllDocuments

Defined in

medusa/src/services/search.ts:69


deleteDocument

deleteDocument(indexName, document_id): Promise<void>

Parameters

Name Type
indexName string
document_id string | number

Returns

Promise<void>

Overrides

AbstractSearchService.deleteDocument

Defined in

medusa/src/services/search.ts:60


getIndex

getIndex(indexName): Promise<void>

Parameters

Name Type
indexName string

Returns

Promise<void>

Overrides

AbstractSearchService.getIndex

Defined in

medusa/src/services/search.ts:34


replaceDocuments

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

Parameters

Name Type
indexName string
documents unknown
type string

Returns

Promise<void>

Overrides

AbstractSearchService.replaceDocuments

Defined in

medusa/src/services/search.ts:50


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

Parameters

Name Type
indexName string
query unknown
options unknown

Returns

Promise<{ hits: unknown[] }>

Overrides

AbstractSearchService.search

Defined in

medusa/src/services/search.ts:75


updateSettings

updateSettings(indexName, settings): Promise<void>

Parameters

Name Type
indexName string
settings unknown

Returns

Promise<void>

Overrides

AbstractSearchService.updateSettings

Defined in

medusa/src/services/search.ts:86