medusa-store/docs/content/references/services/classes/CustomShippingOptionService.md

Class: CustomShippingOptionService

Hierarchy

• TransactionBaseService<CustomShippingOptionService>

  ↳ CustomShippingOptionService

Constructors

constructor

• new CustomShippingOptionService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<CustomShippingOptionService&gt;.constructor

Defined in

services/custom-shipping-option.ts:19

Properties

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

customShippingOptionRepository_

• Protected customShippingOptionRepository_: typeof CustomShippingOptionRepository

Defined in

services/custom-shipping-option.ts:17

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/custom-shipping-option.ts:15

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/custom-shipping-option.ts:16

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

▸ create(data): Promise<CustomShippingOption>

Parameters

Name	Type	Description
data	CreateCustomShippingOptionInput

Returns

Promise<CustomShippingOption>

Defined in

services/custom-shipping-option.ts:90

---

list

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

Parameters

Name	Type	Description
selector	Selector<CustomShippingOption>
config	FindConfig<CustomShippingOption>

Returns

Promise<CustomShippingOption[]>

Defined in

services/custom-shipping-option.ts:65

---

retrieve

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

Parameters

Name	Type	Description
id	string
config	FindConfig<CustomShippingOption>

Returns

Promise<CustomShippingOption>

Defined in

services/custom-shipping-option.ts:36

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

withTransaction

▸ withTransaction(transactionManager?): CustomShippingOptionService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

CustomShippingOptionService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16