Skip to main content
Skip to main content

AnalyticsConfigService

Constructors​

constructor​

**new AnalyticsConfigService**(«destructured»)

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
analyticsConfigRepository_Repository<AnalyticsConfig>Required
manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
userService_UserServiceRequired

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**(userId, data): Promise&#60;[AnalyticsConfig](/references/services/classes/AnalyticsConfig)&#62;

Creates an analytics config.

Parameters​

userIdstringRequired
dataCreateAnalyticsConfigRequired

Returns​

Promise<AnalyticsConfig>

PromisePromise<AnalyticsConfig>Required

delete​

**delete**(userId): Promise&#60;void&#62;

Deletes an analytics config.

Parameters​

userIdstringRequired

Returns​

Promise<void>

PromisePromise<void>Required

retrieve​

**retrieve**(userId): Promise&#60;[AnalyticsConfig](/references/services/classes/AnalyticsConfig)&#62;

Parameters​

userIdstringRequired

Returns​

Promise<AnalyticsConfig>

PromisePromise<AnalyticsConfig>Required

shouldRetryTransaction_​

Protected **shouldRetryTransaction_**(err): boolean

Parameters​

errRecord<string, unknown> | { code: string }Required

Returns​

boolean

booleanboolean

update​

**update**(userId, update): Promise&#60;[AnalyticsConfig](/references/services/classes/AnalyticsConfig)&#62;

Updates an analytics config. If the config does not exist, it will be created instead.

Parameters​

userIdstringRequired
updateUpdateAnalyticsConfigRequired

Returns​

Promise<AnalyticsConfig>

PromisePromise<AnalyticsConfig>Required

withTransaction​

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

Parameters​

transactionManagerEntityManager

Returns​

AnalyticsConfigService

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