CustomShippingOptionService
Hierarchy
TransactionBaseService↳
CustomShippingOptionService
Constructors
constructor
new CustomShippingOptionService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/custom-shipping-option.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
customShippingOptionRepository_
Protected customShippingOptionRepository_: Repository<CustomShippingOption>
Defined in
medusa/src/services/custom-shipping-option.ts:16
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
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
-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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
create
create<T, TResult>(data): Promise<TResult>
Creates a custom shipping option
| Name | Type |
|---|---|
T | object |
TResult | object |
Parameters
| Name | Description |
|---|---|
data | T |
Returns
Promise<TResult>
-Promise: resolves to the creation result
Defined in
medusa/src/services/custom-shipping-option.ts:80
list
list(selector, config?): Promise<CustomShippingOption[]>
Fetches all custom shipping options based on the given selector
Parameters
| Name | Description |
|---|---|
selector | Selector<CustomShippingOption> |
config | FindConfig<CustomShippingOption> |
Returns
Promise<CustomShippingOption[]>
-Promise: custom shipping options matching the query
-CustomShippingOption[]:
-CustomShippingOption:
Defined in
medusa/src/services/custom-shipping-option.ts:58
retrieve
retrieve(id, config?): Promise<CustomShippingOption>
Retrieves a specific shipping option.
Parameters
| Name | Description |
|---|---|
id | string |
config | FindConfig<CustomShippingOption> |
Returns
Promise<CustomShippingOption>
-Promise: the requested custom shipping option.
-CustomShippingOption:
Defined in
medusa/src/services/custom-shipping-option.ts:31
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
withTransaction
withTransaction(transactionManager?): CustomShippingOptionService
Parameters
| Name |
|---|
transactionManager? |
Returns
-CustomShippingOptionService:
Inherited from
TransactionBaseService.withTransaction