StoreService
Provides layer to manipulate store settings.
Hierarchy
TransactionBaseService↳
StoreService
Constructors
constructor
new StoreService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/store.ts:28
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
currencyRepository_
Protected Readonly currencyRepository_: Repository<Currency>
Defined in
medusa/src/services/store.ts:25
eventBus_
Protected Readonly eventBus_: EventBusService
Defined in
medusa/src/services/store.ts:26
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
storeRepository_
Protected Readonly storeRepository_: Repository<Store>
Defined in
medusa/src/services/store.ts:24
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
addCurrency
addCurrency(code): Promise<Store>
Add a currency to the store
Parameters
| Name | Description |
|---|---|
code | string |
Returns
Promise<Store>
-Promise: result after update
-Store:
Defined in
medusa/src/services/store.ts:208
atomicPhase_
Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
create(): Promise<Store>
Creates a store if it doesn't already exist.
Returns
Promise<Store>
-Promise: The store.
-Store:
Defined in
medusa/src/services/store.ts:45
getDefaultCurrency_
Protected getDefaultCurrency_(code): Partial<Currency>
Parameters
| Name |
|---|
code |
Returns
Partial<Currency>
-Partial:
-Currency:
Defined in
medusa/src/services/store.ts:100
removeCurrency
removeCurrency(code): Promise<any>
Removes a currency from the store
Parameters
| Name | Description |
|---|---|
code | string |
Returns
Promise<any>
-Promise: result after update
-any: (optional)
Defined in
medusa/src/services/store.ts:252
retrieve
retrieve(config?): Promise<Store>
Retrieve the store settings. There is always a maximum of one store.
Parameters
| Name | Description |
|---|---|
config | FindConfig<Store> |
Returns
Promise<Store>
-Promise: the store
-Store:
Defined in
medusa/src/services/store.ts:83
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
update(data): Promise<Store>
Updates a store
Parameters
| Name | Description |
|---|---|
data | UpdateStoreInput |
Returns
Promise<Store>
-Promise: resolves to the update result.
-Store:
Defined in
medusa/src/services/store.ts:116
withTransaction
withTransaction(transactionManager?): StoreService
Parameters
| Name |
|---|
transactionManager? |
Returns
-StoreService:
Inherited from
TransactionBaseService.withTransaction