02d5c1da88
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
6.4 KiB
Class: CustomShippingOptionService
Hierarchy
-
TransactionBaseService<CustomShippingOptionService>↳
CustomShippingOptionService
Constructors
constructor
• new CustomShippingOptionService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters |
InjectedDependencies |
Overrides
TransactionBaseService<CustomShippingOptionService>.constructor
Defined in
packages/medusa/src/services/custom-shipping-option.ts:19
Properties
configModule
• Protected Optional Readonly configModule: Record<string, unknown>
Inherited from
TransactionBaseService.configModule
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:13
container
• Protected Readonly container: unknown
Inherited from
TransactionBaseService.container
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:12
customShippingOptionRepository_
• Protected customShippingOptionRepository_: typeof CustomShippingOptionRepository
Defined in
packages/medusa/src/services/custom-shipping-option.ts:17
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/custom-shipping-option.ts:15
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/custom-shipping-option.ts:16
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
packages/medusa/src/interfaces/transaction-base-service.ts:53
create
▸ create(data): Promise<CustomShippingOption>
Creates a custom shipping option
Parameters
| Name | Type | Description |
|---|---|---|
data |
CreateCustomShippingOptionInput |
the custom shipping option to create |
Returns
Promise<CustomShippingOption>
resolves to the creation result
Defined in
packages/medusa/src/services/custom-shipping-option.ts:88
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
packages/medusa/src/services/custom-shipping-option.ts:64
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
packages/medusa/src/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
packages/medusa/src/interfaces/transaction-base-service.ts:34
withTransaction
▸ withTransaction(transactionManager?): CustomShippingOptionService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:16