StoreService
Provides layer to manipulate store settings.
constructor
Parameters
__namedParametersInjectedDependenciesRequiredProperties
__configModule__Record<string, unknown>__container__anyRequired__moduleDeclaration__Record<string, unknown>manager_EntityManagerRequiredtransactionManager_undefined | EntityManagerRequiredAccessors
activeManager_
Returns
EntityManagerEntityManagerRequiredMethods
addCurrency
Add a currency to the store
Parameters
codestringRequired3 character ISO currency code
Returns
result after update
atomicPhase_
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
TResultobjectRequiredTErrorobjectRequiredParameters
work(transactionManager: EntityManager) => Promise<TResult>Requiredthe 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
PromisePromise<TResult>Requiredthe result of the transactional work
create
Creates a store if it doesn't already exist.
Returns
The store.
getDefaultCurrency_
Parameters
codestringRequiredReturns
removeCurrency
Removes a currency from the store
Parameters
codestringRequired3 character ISO currency code
Returns
PromisePromise<any>Requiredresult after update
retrieve
Retrieve the store settings. There is always a maximum of one store.
Parameters
The config object from which the query will be built
Default: {}
Returns
the store
shouldRetryTransaction_
Parameters
errRecord<string, unknown> | objectRequiredReturns
booleanbooleanupdate
Updates a store
Parameters
dataUpdateStoreInputRequiredan object with the update values.
Returns
resolves to the update result.
withTransaction
Parameters
transactionManagerEntityManagerReturns
StoreServiceobjectRequiredProvides layer to manipulate store settings.
Was this section helpful?