Class: ReturnReasonService
Hierarchy
TransactionBaseService↳
ReturnReasonService
Constructors
constructor
• new ReturnReasonService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/return-reason.ts:18
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
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
retReasonRepo_
• Protected Readonly retReasonRepo_: Repository<ReturnReason>
Defined in
medusa/src/services/return-reason.ts:16
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• Protected get activeManager_(): EntityManager
Returns
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.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> | the transactional work to be done |
isolationOrErrorHandler? | IsolationLevel | (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>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
▸ create(data): Promise<ReturnReason>
Parameters
| Name | Type |
|---|---|
data | CreateReturnReason |
Returns
Promise<ReturnReason>
Defined in
medusa/src/services/return-reason.ts:25
delete
▸ delete(returnReasonId): Promise<void>
Parameters
| Name | Type |
|---|---|
returnReasonId | string |
Returns
Promise<void>
Defined in
medusa/src/services/return-reason.ts:113
list
▸ list(selector, config?): Promise<ReturnReason[]>
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<ReturnReason> | the query object for find |
config | FindConfig<ReturnReason> | config object |
Returns
Promise<ReturnReason[]>
the result of the find operation
Defined in
medusa/src/services/return-reason.ts:68
retrieve
▸ retrieve(returnReasonId, config?): Promise<ReturnReason>
Gets an order by id.
Parameters
| Name | Type | Description |
|---|---|---|
returnReasonId | string | id of order to retrieve |
config | FindConfig<ReturnReason> | config object |
Returns
Promise<ReturnReason>
the order document
Defined in
medusa/src/services/return-reason.ts:87
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err | Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
update
▸ update(id, data): Promise<ReturnReason>
Parameters
| Name | Type |
|---|---|
id | string |
data | UpdateReturnReason |
Returns
Promise<ReturnReason>
Defined in
medusa/src/services/return-reason.ts:46
withTransaction
▸ withTransaction(transactionManager?): ReturnReasonService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction