Class: ReturnReasonService
Hierarchy
TransactionBaseService
Copy to Clipboard↳
ReturnReasonService
Copy to Clipboard
Constructors
constructor
• new ReturnReasonService(__namedParameters
Copy to Clipboard)
Parameters
Name | Type |
---|---|
__namedParameters Copy to Clipboard | InjectedDependencies Copy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/return-reason.ts:21
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
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected
Copy to Clipboard Readonly
Copy to Clipboard __container__: any
Copy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__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
packages/medusa/src/interfaces/transaction-base-service.ts:11
manager_
• Protected
Copy to Clipboard manager_: EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/return-reason.ts:18
retReasonRepo_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard retReasonRepo_: typeof ReturnReasonRepository
Copy to Clipboard
Defined in
packages/medusa/src/services/return-reason.ts:16
transactionManager_
• Protected
Copy to Clipboard transactionManager_: undefined
Copy to Clipboard | EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/return-reason.ts:19
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
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(data
Copy to Clipboard): Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
Parameters
Name | Type |
---|---|
data Copy to Clipboard | CreateReturnReason Copy to Clipboard |
Returns
Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
Defined in
packages/medusa/src/services/return-reason.ts:29
delete
▸ delete(returnReasonId
Copy to Clipboard): Promise
Copy to Clipboard<void
Copy to Clipboard>
Parameters
Name | Type |
---|---|
returnReasonId Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<void
Copy to Clipboard>
Defined in
packages/medusa/src/services/return-reason.ts:117
list
▸ list(selector
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard[]>
Parameters
Name | Type | Description |
---|---|---|
selector Copy to Clipboard | Selector Copy to Clipboard<ReturnReason Copy to Clipboard> | the query object for find |
config Copy to Clipboard | FindConfig Copy to Clipboard<ReturnReason Copy to Clipboard> | config object |
Returns
Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard[]>
the result of the find operation
Defined in
packages/medusa/src/services/return-reason.ts:72
retrieve
▸ retrieve(returnReasonId
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
Gets an order by id.
Parameters
Name | Type | Description |
---|---|---|
returnReasonId Copy to Clipboard | string Copy to Clipboard | id of order to retrieve |
config Copy to Clipboard | FindConfig Copy to Clipboard<ReturnReason Copy to Clipboard> | config object |
Returns
Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
the order document
Defined in
packages/medusa/src/services/return-reason.ts:91
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
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(id
Copy to Clipboard, data
Copy to Clipboard): Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
Parameters
Name | Type |
---|---|
id Copy to Clipboard | string Copy to Clipboard |
data Copy to Clipboard | UpdateReturnReason Copy to Clipboard |
Returns
Promise
Copy to Clipboard<ReturnReason
Copy to Clipboard>
Defined in
packages/medusa/src/services/return-reason.ts:50
withTransaction
▸ withTransaction(transactionManager?
Copy to Clipboard): ReturnReasonService
Copy to Clipboard
Parameters
Name | Type |
---|---|
transactionManager? Copy to Clipboard | EntityManager Copy to Clipboard |
Returns
ReturnReasonService
Copy to Clipboard
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14