medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.CurrencyService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: CurrencyService

internal.internal.CurrencyService

Hierarchy

• TransactionBaseService

  ↳ CurrencyService

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

currencyRepository_

• Protected Readonly currencyRepository_: Repository<Currency>

Defined in

packages/medusa/dist/services/currency.d.ts:19

---

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

packages/medusa/dist/services/currency.d.ts:20

---

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/dist/services/currency.d.ts:21

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

---

Events

▪ Static Readonly Events: Object

Type declaration

Name	Type
UPDATED	string

Defined in

packages/medusa/dist/services/currency.d.ts:16

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:9

Methods

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/dist/interfaces/transaction-base-service.d.ts:24

---

listAndCount

▸ listAndCount(selector, config?): Promise<[Currency[], number]>

Lists currencies based on the provided parameters and includes the count of currencies that match the query.

Parameters

Name	Type	Description
selector	Selector<Currency>	an object that defines rules to filter currencies by
config?	FindConfig<Currency>	object that defines the scope for what should be returned

Returns

Promise<[Currency[], number]>

an array containing the currencies as the first element and the total count of products that matches the query as the second element.

Defined in

packages/medusa/dist/services/currency.d.ts:40

---

retrieveByCode

▸ retrieveByCode(code): Promise<Currency>

Return the currency

Parameters

Name	Type	Description
code	string	The code of the currency that must be retrieve

Returns

Promise<Currency>

The currency

Defined in

packages/medusa/dist/services/currency.d.ts:28

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

update

▸ update(code, data): Promise<undefined | Currency>

Update a currency

Parameters

Name	Type	Description
code	string	The code of the currency to update
data	UpdateCurrencyInput	The data that must be updated on the currency

Returns

Promise<undefined | Currency>

The updated currency

Defined in

packages/medusa/dist/services/currency.d.ts:47

---

withTransaction

▸ withTransaction(transactionManager?): CurrencyService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

CurrencyService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11