Skip to main content

Class: CustomShippingOptionService

Hierarchy

  • TransactionBaseService

    CustomShippingOptionService

Constructors

constructor

new CustomShippingOptionService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

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

NameTypeDescription
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

NameType
TCreateCustomShippingOptionInput | CreateCustomShippingOptionInput[]
TResultT extends CreateCustomShippingOptionInput[] ? CustomShippingOption[] : CustomShippingOption

Parameters

NameTypeDescription
dataTthe 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

NameTypeDescription
selectorSelector<CustomShippingOption>the query object for find
configFindConfig<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

NameTypeDescription
idstringthe id of the custom shipping option to retrieve.
configFindConfig<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

NameType
errRecord<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

NameType
transactionManager?EntityManager

Returns

CustomShippingOptionService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Was this page helpful?