Skip to main content

importAchievementData

importAchievementData(jsonString, currentMetrics, currentUnlocked, options?): ImportResult

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

Imports achievement data from a JSON string

Parameters​

jsonString​

string

JSON string containing exported achievement data

currentMetrics​

AchievementMetrics

Current metrics state

currentUnlocked​

string[]

Current unlocked achievements

options?​

ImportOptions

Import options

Returns​

ImportResult

Import result with success status and any errors

Example​

const result = importAchievementData(
  jsonString,
  currentMetrics,
  currentUnlocked,
  { mergeStrategy: 'merge', validate: true }
);

if (result.success) {
  console.log(`Imported ${result.imported.achievements} achievements`);
} else {
  console.error('Import failed:', result.errors);
}