Skip to main content

EngineConfig

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

Configuration for the Achievement Engine

Properties​

achievements​

achievements: AchievementConfigurationType

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

Achievement configuration (Simple or Complex API format)


eventMapping?​

optional eventMapping: EventMapping

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

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:215

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:219

REST API configuration (required if using StorageType.RestAPI)


storage?​

optional storage: AchievementStorage | AsyncAchievementStorage | StorageType

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

Storage implementation or storage type Defaults to memory storage