Skip to main content
Skip to main content

CurrencyService

Hierarchy

  • TransactionBaseService

    CurrencyService

Constructors

constructor

new CurrencyService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/currency.ts:29

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15


currencyRepository_

Protected Readonly currencyRepository_: Repository<Currency>

Defined in

medusa/src/services/currency.ts:25


eventBusService_

Protected Readonly eventBusService_: EventBusService

Defined in

medusa/src/services/currency.ts:26


featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/currency.ts:27


manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5


transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6


Events

Static Readonly Events: Object

Type declaration

NameType
UPDATEDstring

Defined in

medusa/src/services/currency.ts:21

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

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.

Name
TResult
TError

Parameters

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

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56


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

NameDescription
selectorSelector<Currency>
configFindConfig<Currency>

Returns

Promise<[Currency[], number]>

-Promise: an array containing the currencies as the first element and the total count of products that matches the query as the second element. -Currency[]: -number: (optional)

Defined in

medusa/src/services/currency.ts:78


retrieveByCode

retrieveByCode(code): Promise<Currency>

Return the currency

Parameters

NameDescription
codestring

Returns

Promise<Currency>

-Promise: The currency -Currency:

Defined in

medusa/src/services/currency.ts:47


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37


update

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

Update a currency

Parameters

NameDescription
codestring
dataUpdateCurrencyInput

Returns

Promise<undefined | Currency>

-Promise: The updated currency -undefined \| Currency: (optional)

Defined in

medusa/src/services/currency.ts:100


withTransaction

withTransaction(transactionManager?): CurrencyService

Parameters

Name
transactionManager?

Returns

CurrencyService

-default:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Was this section helpful?