Files
medusa-store/docs/content/references/services/classes/StoreService.md
Shahed Nasser e134f6d237 chore: fixed commit branch on generate reference action (#1857)
* fixed commit branch

* fixes after yarn upgrade
2022-07-15 18:08:07 +03:00

5.8 KiB

Class: StoreService

Hierarchy

Constructors

constructor

new StoreService(__namedParameters)

Parameters

Name Type
__namedParameters InjectedDependencies

Overrides

TransactionBaseService<StoreService&gt;.constructor

Defined in

services/store.ts:33

Properties

configModule

Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule


container

Protected Readonly container: unknown

Inherited from

TransactionBaseService.container


currencyRepository_

Protected Readonly currencyRepository_: typeof CurrencyRepository

Defined in

services/store.ts:30


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

services/store.ts:31


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/store.ts:26


storeRepository_

Protected Readonly storeRepository_: typeof StoreRepository

Defined in

services/store.ts:29


transactionManager_

Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/store.ts:27

Methods

addCurrency

addCurrency(code): Promise<Store>

Parameters

Name Type Description
code string

Returns

Promise<Store>

Defined in

services/store.ts:219


atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name Type Description
work (transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53


create

create(): Promise<Store>

Returns

Promise<Store>

Defined in

services/store.ts:56


getDefaultCurrency_

Protected getDefaultCurrency_(code): Partial<Currency>

Parameters

Name Type
code string

Returns

Partial<Currency>

Defined in

services/store.ts:113


removeCurrency

removeCurrency(code): Promise<any>

Parameters

Name Type Description
code string

Returns

Promise<any>

Defined in

services/store.ts:263


retrieve

retrieve(config?): Promise<Store>

Parameters

Name Type Description
config FindConfig<Store>

Returns

Promise<Store>

Defined in

services/store.ts:92


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name Type
err Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34


update

update(data): Promise<Store>

Parameters

Name Type Description
data UpdateStoreInput

Returns

Promise<Store>

Defined in

services/store.ts:129


withTransaction

withTransaction(transactionManager?): StoreService

Parameters

Name Type
transactionManager? EntityManager

Returns

StoreService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16