074055acbb
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
7.3 KiB
Class: CustomShippingOptionService
Hierarchy
-
TransactionBaseService↳
CustomShippingOptionService
Constructors
constructor
• new CustomShippingOptionService(«destructured»)
Parameters
| Name | Type |
|---|---|
«destructured» |
InjectedDependencies |
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
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<T, TResult>(data): Promise<TResult>
Creates a custom shipping option
Type parameters
| Name | Type |
|---|---|
T |
CreateCustomShippingOptionInput | CreateCustomShippingOptionInput[] |
TResult |
T extends CreateCustomShippingOptionInput[] ? CustomShippingOption[] : CustomShippingOption |
Parameters
| Name | Type | Description |
|---|---|---|
data |
T |
the custom shipping option to create |
Returns
Promise<TResult>
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 | Type | Description |
|---|---|---|
selector |
Selector<CustomShippingOption> |
the query object for find |
config |
FindConfig<CustomShippingOption> |
the configuration used to find the objects. contains relations, skip, and take. |
Returns
Promise<CustomShippingOption[]>
custom shipping options matching the query
Defined in
medusa/src/services/custom-shipping-option.ts:58
retrieve
▸ retrieve(id, config?): Promise<CustomShippingOption>
Retrieves a specific shipping option.
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
the id of the custom shipping option to retrieve. |
config |
FindConfig<CustomShippingOption> |
any options needed to query for the result. |
Returns
Promise<CustomShippingOption>
the requested custom shipping option.
Defined in
medusa/src/services/custom-shipping-option.ts:31
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
withTransaction
▸ withTransaction(transactionManager?): CustomShippingOptionService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction