oracular / STATE_VERSION

Variable: STATE_VERSION

const STATE_VERSION: 3;

Defined in: version.ts:24

Version of the serialized state shape, stored in every state as state.version. Bumped only when EngineState changes incompatibly, and every bump ships its migration: deserialize upgrades states saved by earlier versions of this library on its own (version 1, written by oracular 0.1.0 to 0.2.x, and version 2, written by 0.3.0 to 0.5.x, become version 3), reads a state one version newer than its own as its own (a version bump only adds fields, so a rollback by one release keeps the user's history), and calls your migrate function only for a version it does not know.

Example

import { STATE_VERSION, deserialize } from 'oracular';

const state = deserialize(saved, {
  config,
  // Only reached for versions this library cannot migrate itself, such as a state written by a
  // newer oracular before a rollback.
  migrate: (stored, version) => {
    throw new Error(`cannot read oracular state version ${version} (this build reads ${STATE_VERSION})`);
  },
});