Skip to content
YAGE Logo YAGE

RestoreOptions

Defined in: packages/save/src/Save.ts:107

Options for a versioned read (restore, loadSlot, autoPersist).

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T

Properties

Section titled “Properties”

migrate?

Section titled “migrate?”

optional migrate?: (old, fromVersion) => T

Defined in: packages/save/src/Save.ts:116

Migrate previously-stored payload to the current encoded form. Receives the raw decoded payload (whatever shape the older version wrote) and the version it was written at. Return the new encoded form that this build’s Serializable.hydrate accepts.

Parameters

Section titled “Parameters”
old
Section titled “old”

unknown

fromVersion
Section titled “fromVersion”

number

Returns

Section titled “Returns”

T

version?

Section titled “version?”

optional version?: number

Defined in: packages/save/src/Save.ts:109

Current schema version. Defaults to 1.