Skip to main content
Skip to main content

ReturnReasonService

Constructors​

constructor​

new ReturnReasonService(«destructured»)

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
manager_EntityManagerRequired
retReasonRepo_Repository<ReturnReason>Required
transactionManager_undefined | EntityManagerRequired

Accessors​

activeManager_​

Protected get activeManager_(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

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.

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

create​

create(data): Promise<ReturnReason>

Parameters​

dataCreateReturnReasonRequired

Returns​

Promise<ReturnReason>

PromisePromise<ReturnReason>Required

delete​

delete(returnReasonId): Promise<void>

Parameters​

returnReasonIdstringRequired

Returns​

Promise<void>

PromisePromise<void>Required

list​

list(selector, config?): Promise<ReturnReason[]>

Parameters​

selectorSelector<ReturnReason>Required
the query object for find
configFindConfig<ReturnReason>Required
config object

Returns​

Promise<ReturnReason[]>

PromisePromise<ReturnReason[]>Required
the result of the find operation

retrieve​

retrieve(returnReasonId, config?): Promise<ReturnReason>

Gets an order by id.

Parameters​

returnReasonIdstringRequired
id of order to retrieve
configFindConfig<ReturnReason>Required
config object

Default: {}

Returns​

Promise<ReturnReason>

PromisePromise<ReturnReason>Required
the order document

shouldRetryTransaction_​

Protected shouldRetryTransaction_(err): boolean

Parameters​

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

Returns​

boolean

booleanboolean

update​

update(id, data): Promise<ReturnReason>

Parameters​

idstringRequired
dataUpdateReturnReasonRequired

Returns​

Promise<ReturnReason>

PromisePromise<ReturnReason>Required

withTransaction​

withTransaction(transactionManager?): ReturnReasonService

Parameters​

transactionManagerEntityManager

Returns​

ReturnReasonService

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