CustomShippingOptionService

internal.internal.CustomShippingOptionService

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

customShippingOptionRepository_Repository<CustomShippingOption>Required

manager_EntityManagerRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

EntityManagerEntityManagerRequired

Inherited from

TransactionBaseService.activeManager_

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

Inherited from

TransactionBaseService.atomicPhase_

---

create

create<T, TResult>(data): Promise<TResult>

Creates a custom shipping option

TobjectRequired

TResultobjectRequired

Parameters

dataTRequired

the custom shipping option to create

Returns

Promise<TResult>

PromisePromise<TResult>Required

resolves to the creation result

---

list

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

Fetches all custom shipping options based on the given selector

Parameters

selectorSelector<CustomShippingOption>Required

the query object for find

configFindConfig<CustomShippingOption>

the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<CustomShippingOption[]>

PromisePromise<CustomShippingOption[]>Required

custom shipping options matching the query

---

retrieve

retrieve(id, config?): Promise<CustomShippingOption>

Retrieves a specific shipping option.

Parameters

idstringRequired

the id of the custom shipping option to retrieve.

configFindConfig<CustomShippingOption>

any options needed to query for the result.

Returns

Promise<CustomShippingOption>

PromisePromise<CustomShippingOption>Required

the requested custom shipping option.

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

booleanboolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

---

withTransaction

withTransaction(transactionManager?): CustomShippingOptionService

Parameters

transactionManagerEntityManager

Returns

CustomShippingOptionService

CustomShippingOptionServiceCustomShippingOptionServiceRequired

Inherited from

TransactionBaseService.withTransaction