Skip to main content
Skip to main content

CurrencyService

Constructors​

constructor​

**new CurrencyService**(«destructured»)

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
currencyRepository_Repository<Currency>Required
eventBusService_EventBusServiceRequired
featureFlagRouter_FlagRouterRequired
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
EventsobjectRequired
Events.UPDATEDstringRequired

Default: "currency.updated"

Accessors​

activeManager_​

Protected get**activeManager_**(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

Methods​

atomicPhase_​

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

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.

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​

Promise<TResult>

PromisePromise<TResult>Required
the result of the transactional work

listAndCount​

**listAndCount**(selector, config?): Promise&#60;[[Currency](/references/services/classes/Currency)[], number]&#62;

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

Parameters​

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

Returns​

Promise<[Currency[], number]>

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.

retrieveByCode​

**retrieveByCode**(code): Promise&#60;[Currency](/references/services/classes/Currency)&#62;

Return the currency

Parameters​

codestringRequired
The code of the currency that must be retrieve

Returns​

Promise<Currency>

PromisePromise<Currency>Required
The currency

shouldRetryTransaction_​

Protected **shouldRetryTransaction_**(err): boolean

Parameters​

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

Returns​

boolean

booleanboolean

update​

**update**(code, data): Promise&#60;undefined \| [Currency](/references/services/classes/Currency)&#62;

Update a currency

Parameters​

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

Returns​

Promise<undefined | Currency>

PromisePromise<undefined | Currency>Required
The updated currency

withTransaction​

**withTransaction**(transactionManager?): [CurrencyService](/references/services/classes/CurrencyService)

Parameters​

transactionManagerEntityManager

Returns​

CurrencyService

defaultCurrencyServiceRequired
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.