Skip to main content
Skip to main content

CustomShippingOptionService

Constructors​

constructor​

**new CustomShippingOptionService**(«destructured»)

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
customShippingOptionRepository_Repository<CustomShippingOption>Required
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired

Accessors​

activeManager_​

Protected get**activeManager_**(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

Methods​

atomicPhase_​

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

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.

TResultobjectRequired
TErrorobjectRequired

Parameters​

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (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>

PromisePromise<TResult>Required
the result of the transactional work

create​

**create**<TypeParameter T, TypeParameter TResult>(data): Promise&#60;TResult&#62;

Creates a custom shipping option

TobjectRequired
TResultobjectRequired

Parameters​

dataTRequired
the custom shipping option to create

Returns​

Promise<TResult>

PromisePromise<TResult>Required
resolves to the creation result

list​

**list**(selector, config?): Promise&#60;[CustomShippingOption](/references/services/classes/CustomShippingOption)[]&#62;

Fetches all custom shipping options based on the given selector

Parameters​

selectorSelector<CustomShippingOption>Required
the query object for find
configFindConfig<CustomShippingOption>Required
the configuration used to find the objects. contains relations, skip, and take.

Returns​

Promise<CustomShippingOption[]>

PromisePromise<CustomShippingOption[]>Required
custom shipping options matching the query

retrieve​

**retrieve**(id, config?): Promise&#60;[CustomShippingOption](/references/services/classes/CustomShippingOption)&#62;

Retrieves a specific shipping option.

Parameters​

idstringRequired
the id of the custom shipping option to retrieve.
configFindConfig<CustomShippingOption>Required
any options needed to query for the result.

Default: {}

Returns​

Promise<CustomShippingOption>

PromisePromise<CustomShippingOption>Required
the requested custom shipping option.

shouldRetryTransaction_​

Protected **shouldRetryTransaction_**(err): boolean

Parameters​

errRecord<string, unknown> | &#123; code: string &#125;Required

Returns​

boolean

booleanboolean

withTransaction​

**withTransaction**(transactionManager?): [CustomShippingOptionService](/references/services/classes/CustomShippingOptionService)

Parameters​

transactionManagerEntityManager

Returns​

CustomShippingOptionService

CustomShippingOptionServiceCustomShippingOptionServiceRequired
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.