@atlaskit/editor-common/dist/types/user-preferences/persistence-api.d.ts

A package that contains common classes and components for editor and renderer

import type { UserPreferences } from './user-preferences';
export type PersistenceAPI = {
    /**
     * Get the initial user preferences synchronously
     * This function is called on initialization
     * If not provided, loadUserPreferences will be called instead
     * @param userPreferences
     * @returns
     */
    getInitialUserPreferences?: () => UserPreferences | undefined;
    /**
     * Loads the user preferences
     * @returns
     */
    loadUserPreferences: () => Promise<UserPreferences>;
    /**
     * Update a single user preference
     * @param key
     * @param value
     * @returns
     */
    updateUserPreference: <K extends keyof UserPreferences>(key: K, value: UserPreferences[K]) => Promise<Pick<UserPreferences, K>>;
};