AdaptablePersistStateFunction

View as Markdown

Function that handles persisting state to storage systems (localStorage, server, etc.). Called after saveState() to store the prepared state.

This is the place to apply any custom storage format (envelope, compression, encryption, etc.); the matching loadState() is expected to undo it.

TypeScript
export interface

Calls

TypeScript
(state: AdaptablePersistentState, adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<unknown>;
Parameters
ParameterType
stateAdaptablePersistentState
adaptableStateFunctionConfigAdaptableStateFunctionConfig
Returns

Promise<unknown>