index.d.ts

import { StoreonModule } from 'storeon';

declare namespace StoreonLocalStorage {
  export interface Config {
    key?: string;
    storage?: Storage;
    serializer?: (object: any) => string;
    deserializer?: (data: string) => any;
    debug?: boolean;
  }
}

/**
 * Storeon module to persist state to local storage
 *
 * @param {String[]|RegExp[]} paths The keys of state object
 *    that will be store in local storage
 * @param {Config} config The config object
 * @param {String} [config.key='storeon'] The default key
 *    to use in local storage
 * @param {Storage} [config.storage] Can be set as `sessionStorage` or
 *    `localStorage`. Defaults value is `localStorage`.
 *     Defaults value is `localStorage`.
 */
export declare function persistState<State>(
  paths?: string[]|RegExp[],
  config?: StoreonLocalStorage.Config
): StoreonModule<State>;