Class: SearchService
Hierarchy
AbstractSearchServiceCopy to Clipboard↳
SearchServiceCopy to Clipboard
Constructors
constructor
• new SearchService(__namedParametersCopy to Clipboard, optionsCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | InjectedDependenciesCopy to Clipboard |
optionsCopy to Clipboard | anyCopy to Clipboard |
Overrides
AbstractSearchService.constructor
Defined in
medusa/src/services/search.ts:16
Properties
isDefault
• isDefault: booleanCopy to Clipboard = trueCopy to Clipboard
Overrides
AbstractSearchService.isDefault
Defined in
medusa/src/services/search.ts:11
logger_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard logger_: LoggerCopy to Clipboard
Defined in
medusa/src/services/search.ts:13
options_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard options_: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Overrides
AbstractSearchService.options_
Defined in
medusa/src/services/search.ts:14
Accessors
options
• getCopy to Clipboard options(): RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Returns
RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
AbstractSearchService.options
Defined in
utils/dist/search/abstract-service.d.ts:5
Methods
addDocuments
▸ addDocuments(indexNameCopy to Clipboard, documentsCopy to Clipboard, typeCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
documentsCopy to Clipboard | unknownCopy to Clipboard |
typeCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.addDocuments
Defined in
medusa/src/services/search.ts:40
createIndex
▸ createIndex(indexNameCopy to Clipboard, optionsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
optionsCopy to Clipboard | unknownCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.createIndex
Defined in
medusa/src/services/search.ts:28
deleteAllDocuments
▸ deleteAllDocuments(indexNameCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.deleteAllDocuments
Defined in
medusa/src/services/search.ts:69
deleteDocument
▸ deleteDocument(indexNameCopy to Clipboard, document_idCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
document_idCopy to Clipboard | stringCopy to Clipboard | numberCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.deleteDocument
Defined in
medusa/src/services/search.ts:60
getIndex
▸ getIndex(indexNameCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.getIndex
Defined in
medusa/src/services/search.ts:34
replaceDocuments
▸ replaceDocuments(indexNameCopy to Clipboard, documentsCopy to Clipboard, typeCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
documentsCopy to Clipboard | unknownCopy to Clipboard |
typeCopy to Clipboard | stringCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.replaceDocuments
Defined in
medusa/src/services/search.ts:50
search
▸ search(indexNameCopy to Clipboard, queryCopy to Clipboard, optionsCopy to Clipboard): PromiseCopy to Clipboard<{ hitsCopy to Clipboard: unknownCopy to Clipboard[] }>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
queryCopy to Clipboard | unknownCopy to Clipboard |
optionsCopy to Clipboard | unknownCopy to Clipboard |
Returns
PromiseCopy to Clipboard<{ hitsCopy to Clipboard: unknownCopy to Clipboard[] }>
Overrides
AbstractSearchService.search
Defined in
medusa/src/services/search.ts:75
updateSettings
▸ updateSettings(indexNameCopy to Clipboard, settingsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>
Parameters
| Name | Type |
|---|---|
indexNameCopy to Clipboard | stringCopy to Clipboard |
settingsCopy to Clipboard | unknownCopy to Clipboard |
Returns
PromiseCopy to Clipboard<voidCopy to Clipboard>
Overrides
AbstractSearchService.updateSettings