Skip to main content

EngineConfig

Defined in: node_modules/achievements-engine/dist/index.d.ts:192

Configuration for the Achievement Engine

Properties

achievements

achievements: AchievementConfigurationType

Defined in: node_modules/achievements-engine/dist/index.d.ts:196

Achievement configuration (Simple or Complex API format)


eventMapping?

optional eventMapping: EventMapping

Defined in: node_modules/achievements-engine/dist/index.d.ts:206

Optional event-to-metric mapping Enables event-based tracking with emit()


onError()?

optional onError: (error) => void

Defined in: node_modules/achievements-engine/dist/index.d.ts:210

Error handler for async operations and achievement errors

Parameters

error

Error

Returns

void


restApiConfig?

optional restApiConfig: RestApiStorageConfig

Defined in: node_modules/achievements-engine/dist/index.d.ts:214

REST API configuration (required if using StorageType.RestAPI)


storage?

optional storage: AchievementStorage | AsyncAchievementStorage | StorageType

Defined in: node_modules/achievements-engine/dist/index.d.ts:201

Storage implementation or storage type Defaults to memory storage