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
packages/medusa/src/services/search.ts:18
Properties
__configModule__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
AbstractSearchService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
AbstractSearchService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
AbstractSearchService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
isDefault
• isDefault: booleanCopy to Clipboard = trueCopy to Clipboard
Overrides
AbstractSearchService.isDefault
Defined in
packages/medusa/src/services/search.ts:11
logger_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard logger_: LoggerCopy to Clipboard
Defined in
packages/medusa/src/services/search.ts:15
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Overrides
AbstractSearchService.manager_
Defined in
packages/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
packages/medusa/src/services/search.ts:16
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Overrides
AbstractSearchService.transactionManager_
Defined in
packages/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
packages/medusa/src/interfaces/search-service.ts:82
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
packages/medusa/src/services/search.ts:43
atomicPhase_
▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
Type parameters
| Name |
|---|
TResultCopy to Clipboard |
TErrorCopy to Clipboard |
Parameters
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail?Copy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | Potential error handler |
Returns
PromiseCopy to Clipboard<TResultCopy to Clipboard>
the result of the transactional work
Inherited from
AbstractSearchService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
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
packages/medusa/src/services/search.ts:31
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
packages/medusa/src/services/search.ts:72
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
packages/medusa/src/services/search.ts:63
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
packages/medusa/src/services/search.ts:37
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
packages/medusa/src/services/search.ts:53
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
packages/medusa/src/services/search.ts:78
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
AbstractSearchService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
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
Defined in
packages/medusa/src/services/search.ts:89
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): SearchServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
SearchServiceCopy to Clipboard
Inherited from
AbstractSearchService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14