Class: CurrencyService
Hierarchy
TransactionBaseService
Copy to Clipboard↳
CurrencyService
Copy to Clipboard
Constructors
constructor
• new CurrencyService(__namedParameters
Copy to Clipboard)
Parameters
Name | Type |
---|---|
__namedParameters Copy to Clipboard | InjectedDependencies Copy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/currency.ts:29
Properties
__configModule__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __configModule__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• Protected
Copy to Clipboard Readonly
Copy to Clipboard __container__: any
Copy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __moduleDeclaration__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
currencyRepository_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard currencyRepository_: Repository
Copy to Clipboard<Currency
Copy to Clipboard>
Defined in
medusa/src/services/currency.ts:25
eventBusService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard eventBusService_: EventBusService
Copy to Clipboard
Defined in
medusa/src/services/currency.ts:26
featureFlagRouter_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard featureFlagRouter_: FlagRouter
Copy to Clipboard
Defined in
medusa/src/services/currency.ts:27
manager_
• Protected
Copy to Clipboard manager_: EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
transactionManager_
• Protected
Copy to Clipboard transactionManager_: undefined
Copy to Clipboard | EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Events
▪ Static
Copy to Clipboard Readonly
Copy to Clipboard Events: Object
Copy to Clipboard
Type declaration
Name | Type |
---|---|
UPDATED Copy to Clipboard | string Copy to Clipboard |
Defined in
medusa/src/services/currency.ts:21
Accessors
activeManager_
• Protected
Copy to Clipboard get
Copy to Clipboard activeManager_(): EntityManager
Copy to Clipboard
Returns
EntityManager
Copy to Clipboard
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
▸ Protected
Copy to Clipboard atomicPhase_<TResult
Copy to Clipboard, TError
Copy to Clipboard>(work
Copy to Clipboard, isolationOrErrorHandler?
Copy to Clipboard, maybeErrorHandlerOrDontFail?
Copy to Clipboard): Promise
Copy to Clipboard<TResult
Copy to Clipboard>
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 Copy to Clipboard |
TError Copy to Clipboard |
Parameters
Name | Type | Description |
---|---|---|
work Copy to Clipboard | (transactionManager Copy to Clipboard: EntityManager Copy to Clipboard) => Promise Copy to Clipboard<TResult Copy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler? Copy to Clipboard | IsolationLevel Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | Potential error handler |
Returns
Promise
Copy to Clipboard<TResult
Copy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
listAndCount
▸ listAndCount(selector
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<[Currency
Copy to Clipboard[], number
Copy to Clipboard]>
Lists currencies based on the provided parameters and includes the count of currencies that match the query.
Parameters
Name | Type | Description |
---|---|---|
selector Copy to Clipboard | Selector Copy to Clipboard<Currency Copy to Clipboard> | an object that defines rules to filter currencies by |
config Copy to Clipboard | FindConfig Copy to Clipboard<Currency Copy to Clipboard> | object that defines the scope for what should be returned |
Returns
Promise
Copy to Clipboard<[Currency
Copy to Clipboard[], number
Copy to Clipboard]>
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
medusa/src/services/currency.ts:78
retrieveByCode
▸ retrieveByCode(code
Copy to Clipboard): Promise
Copy to Clipboard<Currency
Copy to Clipboard>
Return the currency
Parameters
Name | Type | Description |
---|---|---|
code Copy to Clipboard | string Copy to Clipboard | The code of the currency that must be retrieve |
Returns
Promise
Copy to Clipboard<Currency
Copy to Clipboard>
The currency
Defined in
medusa/src/services/currency.ts:47
shouldRetryTransaction_
▸ Protected
Copy to Clipboard shouldRetryTransaction_(err
Copy to Clipboard): boolean
Copy to Clipboard
Parameters
Name | Type |
---|---|
err Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, unknown Copy to Clipboard> | { code Copy to Clipboard: string Copy to Clipboard } |
Returns
boolean
Copy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
▸ update(code
Copy to Clipboard, data
Copy to Clipboard): Promise
Copy to Clipboard<undefined
Copy to Clipboard | Currency
Copy to Clipboard>
Update a currency
Parameters
Name | Type | Description |
---|---|---|
code Copy to Clipboard | string Copy to Clipboard | The code of the currency to update |
data Copy to Clipboard | UpdateCurrencyInput Copy to Clipboard | The data that must be updated on the currency |
Returns
Promise
Copy to Clipboard<undefined
Copy to Clipboard | Currency
Copy to Clipboard>
The updated currency
Defined in
medusa/src/services/currency.ts:100
withTransaction
▸ withTransaction(transactionManager?
Copy to Clipboard): CurrencyService
Copy to Clipboard
Parameters
Name | Type |
---|---|
transactionManager? Copy to Clipboard | EntityManager Copy to Clipboard |
Returns
CurrencyService
Copy to Clipboard
Inherited from
TransactionBaseService.withTransaction