Skip to main content

Class: CurrencyService

Hierarchy

  • TransactionBaseService

    CurrencyService

Constructors

constructor

new CurrencyService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/currency.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:10


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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


currencyRepository_

Protected Readonly currencyRepository_: typeof CurrencyRepository

Defined in

packages/medusa/src/services/currency.ts:28


eventBusService_

Protected Readonly eventBusService_: EventBusService

Defined in

packages/medusa/src/services/currency.ts:29


featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/src/services/currency.ts:30


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/currency.ts:25


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/currency.ts:26


Events

Static Readonly Events: Object

Type declaration

NameType
UPDATEDstring

Defined in

packages/medusa/src/services/currency.ts:21

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

NameTypeDescription
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:50


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

NameTypeDescription
selectorSelector<Currency>an object that defines rules to filter currencies by
configFindConfig<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/src/services/currency.ts:81


retrieveByCode

retrieveByCode(code): Promise<Currency>

Return the currency

Parameters

NameTypeDescription
codestringThe code of the currency that must be retrieve

Returns

Promise<Currency>

The currency

Defined in

packages/medusa/src/services/currency.ts:50


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31


update

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

Update a currency

Parameters

NameTypeDescription
codestringThe code of the currency to update
dataUpdateCurrencyInputThe data that must be updated on the currency

Returns

Promise<undefined | Currency>

The updated currency

Defined in

packages/medusa/src/services/currency.ts:103


withTransaction

withTransaction(transactionManager?): CurrencyService

Parameters

NameType
transactionManager?EntityManager

Returns

CurrencyService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14