Skip to main content
Skip to main content
You're viewing the documentation for v1, which isn't the latest Medusa version.Latest documentation

CurrencyService

constructor​

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
__container__anyRequired
EventsobjectRequired
Events.UPDATEDstringRequired

Default: "currency.updated"

currencyRepository_Repository<Currency>Required
eventBusService_EventBusServiceRequired
featureFlagRouter_FlagRouterRequired
__configModule__Record<string, unknown>
__moduleDeclaration__Record<string, unknown>

Accessors​

activeManager_​

Returns​

EntityManagerEntityManagerRequired

Methods​

withTransaction​

Parameters​

transactionManagerEntityManager

Returns​

thisthisRequired

shouldRetryTransaction_​

Parameters​

errRecord<string, unknown> | objectRequired

Returns​

booleanbooleanRequired

atomicPhase_​

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​

TResultobjectRequired
TErrorobjectRequired

Parameters​

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>
the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>
Potential error handler

Returns​

PromisePromise<TResult>Required
the result of the transactional work

retrieveByCode​

Return the currency

Parameters​

codestringRequired
The code of the currency that must be retrieve

Returns​

PromisePromise<Currency>Required
The currency

listAndCount​

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

Parameters​

selectorSelector<Currency> & objectRequired
an object that defines rules to filter currencies by
configFindConfig<Currency>Required
object that defines the scope for what should be returned

Returns​

PromisePromise<[Currency[], number]>Required
an array containing the currencies as the first element and the total count of products that matches the query as the second element.

update​

Update a currency

Parameters​

codestringRequired
The code of the currency to update
dataUpdateCurrencyInputRequired
The data that must be updated on the currency

Returns​

PromisePromise<undefined | Currency>Required
The updated currency
Was this section helpful?