02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
7.2 KiB
Class: StoreService
Provides layer to manipulate store settings.
Hierarchy
-
TransactionBaseService<StoreService>↳
StoreService
Constructors
constructor
• new StoreService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService<StoreService>.constructor
Defined in
packages/medusa/src/services/store.ts:32
Properties
configModule
• Protected Optional Readonly configModule: Record<string, unknown>
Inherited from
TransactionBaseService.configModule
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:13
container
• Protected Readonly container: unknown
Inherited from
TransactionBaseService.container
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:12
currencyRepository_
• Protected Readonly currencyRepository_: typeof CurrencyRepository
Defined in
packages/medusa/src/services/store.ts:29
eventBus_
• Protected Readonly eventBus_: EventBusService
Defined in
packages/medusa/src/services/store.ts:30
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/store.ts:25
storeRepository_
• Protected Readonly storeRepository_: typeof StoreRepository
Defined in
packages/medusa/src/services/store.ts:28
transactionManager_
• Protected transactionManager_: EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/store.ts:26
Methods
addCurrency
▸ addCurrency(code): Promise<Store>
Add a currency to the store
Parameters
| Name | Type | Description |
|---|---|---|
code |
string |
3 character ISO currency code |
Returns
Promise<Store>
result after update
Defined in
packages/medusa/src/services/store.ts:210
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.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work |
(transactionManager: EntityManager) => Promise<TResult> |
the transactional work to be done |
isolationOrErrorHandler? |
IsolationLevel | (error: TError) => Promise<void | TResult> |
the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? |
(error: TError) => Promise<void | TResult> |
Potential error handler |
Returns
Promise<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:53
create
▸ create(): Promise<Store>
Creates a store if it doesn't already exist.
Returns
Promise<Store>
The store.
Defined in
packages/medusa/src/services/store.ts:55
getDefaultCurrency_
▸ Protected getDefaultCurrency_(code): Partial<Currency>
Parameters
| Name | Type |
|---|---|
code |
string |
Returns
Partial<Currency>
Defined in
packages/medusa/src/services/store.ts:104
removeCurrency
▸ removeCurrency(code): Promise<any>
Removes a currency from the store
Parameters
| Name | Type | Description |
|---|---|---|
code |
string |
3 character ISO currency code |
Returns
Promise<any>
result after update
Defined in
packages/medusa/src/services/store.ts:254
retrieve
▸ retrieve(config?): Promise<Store>
Retrieve the store settings. There is always a maximum of one store.
Parameters
| Name | Type | Description |
|---|---|---|
config |
FindConfig<Store> |
The config object from which the query will be built |
Returns
Promise<Store>
the store
Defined in
packages/medusa/src/services/store.ts:91
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:34
update
▸ update(data): Promise<Store>
Updates a store
Parameters
| Name | Type | Description |
|---|---|---|
data |
UpdateStoreInput |
an object with the update values. |
Returns
Promise<Store>
resolves to the update result.
Defined in
packages/medusa/src/services/store.ts:120
withTransaction
▸ withTransaction(transactionManager?): StoreService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:16