PersistConfig
Type Alias: PersistConfig<TState>
Section titled “Type Alias: PersistConfig<TState>”PersistConfig<
TState> =object
Defined in: types.ts:62
Configuration for persisting store state to a storage backend.
Type Parameters
Section titled “Type Parameters”TState
Section titled “TState”TState
Properties
Section titled “Properties”deserialize?
Section titled “deserialize?”
optionaldeserialize?: (value) =>unknown
Defined in: types.ts:74
Custom deserializer. Defaults to JSON.parse.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”unknown
migrate?
Section titled “migrate?”
optionalmigrate?:MigrationMap<TState>
Defined in: types.ts:68
Migrations from older versions to the current version.
partialize?
Section titled “partialize?”
optionalpartialize?: (state) =>Partial<TState>
Defined in: types.ts:70
Keys to include in persistence. If omitted, the entire state is persisted.
Parameters
Section titled “Parameters”TState
Returns
Section titled “Returns”Partial<TState>
serialize?
Section titled “serialize?”
optionalserialize?: (value) =>string
Defined in: types.ts:72
Custom serializer. Defaults to JSON.stringify.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”string
storage?
Section titled “storage?”
optionalstorage?:StorageBackend
Defined in: types.ts:64
Storage backend. Defaults to "local" in browsers, "memory" in Node.
version?
Section titled “version?”
optionalversion?:number
Defined in: types.ts:66
Schema version. Increment when state shape changes.