diff --git a/classes/GenericStorageWrapper.html b/classes/GenericStorageWrapper.html index 1523fa26c..187007943 100644 --- a/classes/GenericStorageWrapper.html +++ b/classes/GenericStorageWrapper.html @@ -1,7 +1,7 @@ GenericStorageWrapper | Vuex - Long Term Memory

Class GenericStorageWrapper<Outer, Inner>

Builds a custom storage that can be passed to LTM.

Typeparam

Outer - The Vuex state type.

Typeparam

Inner - The storage state type.

-

Type Parameters

Implements

Constructors

Type Parameters

Implements

Constructors

Methods

Constructors

Methods

\ No newline at end of file +

Constructors

Methods

\ No newline at end of file diff --git a/classes/LTM.html b/classes/LTM.html index 18717c56a..dcbc2b23c 100644 --- a/classes/LTM.html +++ b/classes/LTM.html @@ -1,8 +1,8 @@ LTM | Vuex - Long Term Memory

Long Term Memory main class.

Typeparam

S - Vuex state type.

-

Type Parameters

  • S

Constructors

Type Parameters

  • S

Constructors

Properties

Accessors

Constructors

Properties

ready: Promise<void>

Resolves when the state has been restored or no persisted state was found.

-

Accessors

  • get plugin(): Plugin<S>
  • Vuex plugin (i.e. new Vuex.Store({ plugins: [ltm.plugin] })).

    -

    Returns Plugin<S>

\ No newline at end of file +

Constructors

Properties

ready: Promise<void>

Resolves when the state has been restored or no persisted state was found.

+

Accessors

\ No newline at end of file diff --git a/functions/chromeLocalStorage.html b/functions/chromeLocalStorage.html index 1883f635a..da278baf2 100644 --- a/functions/chromeLocalStorage.html +++ b/functions/chromeLocalStorage.html @@ -4,4 +4,4 @@
  • Optional toOuter: ToOuter<Outer, Inner>

    Custom conversion from storage object to state object (default is pass through).

  • Returns GenericStorageWrapper<Outer, Inner>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/chromeStorageWrapper.html b/functions/chromeStorageWrapper.html index feec42d35..116eda469 100644 --- a/functions/chromeStorageWrapper.html +++ b/functions/chromeStorageWrapper.html @@ -5,4 +5,4 @@
  • toOuter: ToOuter<Outer, Inner> = ...

    Custom conversion from storage object to state object (default is pass through).

  • Returns GenericStorageWrapper<Outer, Inner>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/chromeSyncStorage.html b/functions/chromeSyncStorage.html index da1777bd7..c20185443 100644 --- a/functions/chromeSyncStorage.html +++ b/functions/chromeSyncStorage.html @@ -4,4 +4,4 @@
  • Optional toOuter: ToOuter<Outer, Inner>

    Custom conversion from storage object to state object (default is pass through).

  • Returns GenericStorageWrapper<Outer, Inner>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/configurableDeepMerge.html b/functions/configurableDeepMerge.html index e5c1a8b61..62c884899 100644 --- a/functions/configurableDeepMerge.html +++ b/functions/configurableDeepMerge.html @@ -1,4 +1,4 @@ configurableDeepMerge | Vuex - Long Term Memory

    Function configurableDeepMerge

    • Builds merger that deep merges the states using deepmerge library with custom options.

      Type Parameters

      • S

      Parameters

      • options: Options

        Options to be passed to the library.

      Returns Merger<S>

      Merger that can be passed to LTM.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/deepMerge.html b/functions/deepMerge.html index 8c2302f48..8034eb762 100644 --- a/functions/deepMerge.html +++ b/functions/deepMerge.html @@ -3,4 +3,4 @@
  • previous: S

    State present in Vuex (probably defaults).

  • Returns S

    State that will be put into Vuex.

    Remarks

    See configurableDeepMerge for customizations.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/dummyFilter.html b/functions/dummyFilter.html index 74a77d371..b58a6ef35 100644 --- a/functions/dummyFilter.html +++ b/functions/dummyFilter.html @@ -1,3 +1,3 @@ dummyFilter | Vuex - Long Term Memory
    • Persists everything

      Returns boolean

      Always true.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/executeWithDelay.html b/functions/executeWithDelay.html index 1725a6144..be0f1aae8 100644 --- a/functions/executeWithDelay.html +++ b/functions/executeWithDelay.html @@ -1,4 +1,4 @@ executeWithDelay | Vuex - Long Term Memory
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/inMemoryStorage.html b/functions/inMemoryStorage.html index e26024d1e..1adb462ca 100644 --- a/functions/inMemoryStorage.html +++ b/functions/inMemoryStorage.html @@ -1,4 +1,4 @@ inMemoryStorage | Vuex - Long Term Memory
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/localForage-1.html b/functions/localForage-1.html index de2bfef2e..cc8061e43 100644 --- a/functions/localForage-1.html +++ b/functions/localForage-1.html @@ -5,4 +5,4 @@
  • Optional toOuter: ToOuter<Outer, Inner>

    Custom conversion from storage object to state object (default is pass through).

  • Returns GenericStorageWrapper<Outer, Inner>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/localForageWrapper.html b/functions/localForageWrapper.html index 83e71e7f0..be24ccf11 100644 --- a/functions/localForageWrapper.html +++ b/functions/localForageWrapper.html @@ -5,4 +5,4 @@
  • toOuter: ToOuter<Outer, Inner> = ...

    Custom conversion from storage object to state object (default is pass through).

  • Returns GenericStorageWrapper<Outer, Inner>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/localStorage.html b/functions/localStorage.html index db6ed1b63..4b1ec99a3 100644 --- a/functions/localStorage.html +++ b/functions/localStorage.html @@ -3,4 +3,4 @@
  • Optional toInner: ToInner<Outer, string>

    Custom conversion from state object to string (default is JSON.stringify).

  • Optional toOuter: ToOuter<Outer, string>

    Custom conversion from string to state object (default is JSON.parse).

  • Returns GenericStorageWrapper<Outer, string>

    Typeparam

    Outer - The Vuex state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/localStorageWrapper.html b/functions/localStorageWrapper.html index 41460e8f4..e945e8cd4 100644 --- a/functions/localStorageWrapper.html +++ b/functions/localStorageWrapper.html @@ -4,4 +4,4 @@
  • toInner: ToInner<Outer, string> = ...

    Custom conversion from state object to string (default is JSON.stringify).

  • toOuter: ToOuter<Outer, string> = ...

    Custom conversion from string to state object (default is JSON.parse).

  • Returns GenericStorageWrapper<Outer, string>

    Typeparam

    Outer - The Vuex state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/mutationFilter.html b/functions/mutationFilter.html index c139fc571..59bb8c24c 100644 --- a/functions/mutationFilter.html +++ b/functions/mutationFilter.html @@ -1,3 +1,3 @@ mutationFilter | Vuex - Long Term Memory
    • Builds a filter that filters mutations by given types.

      Parameters

      • mutations: (string | RegExp)[]

        Mutation types that should trigger persisting.

        -

      Returns Filter

    \ No newline at end of file +

    Returns Filter

    \ No newline at end of file diff --git a/functions/pickModules.html b/functions/pickModules.html index 10eb99526..729154bf0 100644 --- a/functions/pickModules.html +++ b/functions/pickModules.html @@ -1,3 +1,3 @@ pickModules | Vuex - Long Term Memory
    • Saves only select modules.

      Type Parameters

      • S

      Parameters

      • moduleNames: string[]

        Names (as they appear in state object) of modules to be persisted.

        -

      Returns Reducer<S>

    \ No newline at end of file +

    Returns Reducer<S>

    \ No newline at end of file diff --git a/functions/replace.html b/functions/replace.html index c499ad2f2..44b2b1bec 100644 --- a/functions/replace.html +++ b/functions/replace.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns S

    State that will be put into Vuex.

    -
  • Type Parameters

    Parameters

    Returns S

  • \ No newline at end of file +
  • Type Parameters

    Parameters

    Returns S

  • \ No newline at end of file diff --git a/functions/saveAll.html b/functions/saveAll.html index 31d04a07e..cfbf96161 100644 --- a/functions/saveAll.html +++ b/functions/saveAll.html @@ -1,2 +1,2 @@ saveAll | Vuex - Long Term Memory
    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns S

    \ No newline at end of file diff --git a/functions/sessionStorage.html b/functions/sessionStorage.html index 7f9518d51..663ea0bc1 100644 --- a/functions/sessionStorage.html +++ b/functions/sessionStorage.html @@ -4,4 +4,4 @@
  • Optional toOuter: ToOuter<Outer, string>

    Custom conversion from string to state object (default is JSON.parse).

  • Returns GenericStorageWrapper<Outer, string>

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/shallowMerge.html b/functions/shallowMerge.html index 9b6b70bdf..26f4d29cd 100644 --- a/functions/shallowMerge.html +++ b/functions/shallowMerge.html @@ -2,4 +2,4 @@

    Type Parameters

    Parameters

    Returns S

    State that will be put into Vuex.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/simplyExecute.html b/functions/simplyExecute.html index 4ed35200c..dcb47b06d 100644 --- a/functions/simplyExecute.html +++ b/functions/simplyExecute.html @@ -1,2 +1,2 @@ simplyExecute | Vuex - Long Term Memory
    • Persists the state immediatelly.

      -

      Parameters

      • func: (() => void)
          • (): void
          • Returns void

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/interfaces/AsyncStorage.html b/interfaces/AsyncStorage.html index 1ad65ce82..43329b117 100644 --- a/interfaces/AsyncStorage.html +++ b/interfaces/AsyncStorage.html @@ -1,6 +1,6 @@ AsyncStorage | Vuex - Long Term Memory

    Interface AsyncStorage<T>

    Storage interface that can be passed to LTM.

    Typeparam

    T - The storage state type.

    Remarks

    Valid storage can also be built using GenericStorageWrapper.

    -
    interface AsyncStorage<T> {
        load(): Promise<null | T>;
        save(obj): Promise<void>;
    }

    Type Parameters

    • T

    Implemented by

    Methods

    interface AsyncStorage<T> {
        load(): Promise<null | T>;
        save(obj): Promise<void>;
    }

    Type Parameters

    • T

    Implemented by

    Methods

    Methods

    \ No newline at end of file +

    Methods

    \ No newline at end of file diff --git a/interfaces/ChromeStorage.html b/interfaces/ChromeStorage.html index 153d27a93..ed0de9f4b 100644 --- a/interfaces/ChromeStorage.html +++ b/interfaces/ChromeStorage.html @@ -1,3 +1,3 @@ -ChromeStorage | Vuex - Long Term Memory

    Interface ChromeStorage<T>

    interface ChromeStorage<T> {
        get(key, callback): void;
        set(data, callback): void;
    }

    Type Parameters

    • T

    Methods

    get +ChromeStorage | Vuex - Long Term Memory

    Interface ChromeStorage<T>

    interface ChromeStorage<T> {
        get(key, callback): void;
        set(data, callback): void;
    }

    Type Parameters

    • T

    Methods

    Methods

    \ No newline at end of file +

    Methods

    \ No newline at end of file diff --git a/interfaces/LTMConfig.html b/interfaces/LTMConfig.html index 2d3b0ff3e..da4d2b43b 100644 --- a/interfaces/LTMConfig.html +++ b/interfaces/LTMConfig.html @@ -1,6 +1,6 @@ -LTMConfig | Vuex - Long Term Memory

    Interface LTMConfig<S>

    interface LTMConfig<S> {
        execute: Executor;
        filter: Filter;
        merge: Merger<S>;
        reduce: Reducer<S>;
        storage: AsyncStorage<Partial<S>>;
    }

    Type Parameters

    • S

    Properties

    execute +LTMConfig | Vuex - Long Term Memory

    Interface LTMConfig<S>

    interface LTMConfig<S> {
        execute: Executor;
        filter: Filter;
        merge: Merger<S>;
        reduce: Reducer<S>;
        storage: AsyncStorage<Partial<S>>;
    }

    Type Parameters

    • S

    Properties

    execute: Executor
    filter: Filter
    merge: Merger<S>
    reduce: Reducer<S>
    storage: AsyncStorage<Partial<S>>
    \ No newline at end of file +

    Properties

    execute: Executor
    filter: Filter
    merge: Merger<S>
    reduce: Reducer<S>
    storage: AsyncStorage<Partial<S>>
    \ No newline at end of file diff --git a/interfaces/LocalForage.html b/interfaces/LocalForage.html index 1db9120f8..e7f513533 100644 --- a/interfaces/LocalForage.html +++ b/interfaces/LocalForage.html @@ -1,3 +1,3 @@ -LocalForage | Vuex - Long Term Memory

    Interface LocalForage<T>

    interface LocalForage<T> {
        getItem(key): Promise<T>;
        setItem(key, data): Promise<void>;
    }

    Type Parameters

    • T

    Methods

    getItem +LocalForage | Vuex - Long Term Memory

    Interface LocalForage<T>

    interface LocalForage<T> {
        getItem(key): Promise<T>;
        setItem(key, data): Promise<void>;
    }

    Type Parameters

    • T

    Methods

    Methods

    \ No newline at end of file +

    Methods

    \ No newline at end of file diff --git a/interfaces/StorageItems.html b/interfaces/StorageItems.html index 401865d24..4b6ff90a0 100644 --- a/interfaces/StorageItems.html +++ b/interfaces/StorageItems.html @@ -1 +1 @@ -StorageItems | Vuex - Long Term Memory

    Interface StorageItems<T>

    interface StorageItems<T> {
        [key: string]: T;
    }

    Type Parameters

    • T

    Indexable

    [key: string]: T
    \ No newline at end of file +StorageItems | Vuex - Long Term Memory

    Interface StorageItems<T>

    interface StorageItems<T> {
        [key: string]: T;
    }

    Type Parameters

    • T

    Indexable

    [key: string]: T
    \ No newline at end of file diff --git a/interfaces/StringStorage.html b/interfaces/StringStorage.html index 1b209d629..be0f3003e 100644 --- a/interfaces/StringStorage.html +++ b/interfaces/StringStorage.html @@ -1,4 +1,4 @@ StringStorage | Vuex - Long Term Memory

    Required subset of localStorage API by localStorageWrapper.

    -
    interface StringStorage {
        getItem(key): null | string;
        setItem(key, data): void;
    }

    Methods

    interface StringStorage {
        getItem(key): null | string;
        setItem(key, data): void;
    }

    Methods

    Methods

    \ No newline at end of file +

    Methods

    \ No newline at end of file diff --git a/types/Executor.html b/types/Executor.html index 4deacaf2c..1e924bd6a 100644 --- a/types/Executor.html +++ b/types/Executor.html @@ -1,3 +1,3 @@ Executor | Vuex - Long Term Memory
    Executor: ((func) => void)

    Manages execution of passed functions (e.g. avoiding bursts by skipping some).

    Type declaration

      • (func): void
      • Parameters

        • func: (() => void)

          Function to be executed (may be thrown away and never executed).

          -
            • (): void
            • Returns void

        Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/types/Filter.html b/types/Filter.html index 59f5b50a4..8679ac387 100644 --- a/types/Filter.html +++ b/types/Filter.html @@ -1,4 +1,4 @@ Filter | Vuex - Long Term Memory
    Filter: ((mutation) => boolean)

    Decides if given mutation should trigger persisting.

    Type declaration

      • (mutation): boolean
      • Parameters

        • mutation: MutationPayload

          The mutation from Vuex.

        Returns boolean

    Returns

    True to persist, false to ignore.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/GetItem.html b/types/GetItem.html index 999e4b7d5..9292bc550 100644 --- a/types/GetItem.html +++ b/types/GetItem.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    Type declaration

    Param: key

    String identifying persisted state (like in localStorage.getItem(key)).

    Typeparam

    T - The storage state type.

    Returns

    The persisted state or null if no state exists in the storage. May return a promise resolving to the forementioned value.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/Merger.html b/types/Merger.html index f1cde5c2f..c3920918c 100644 --- a/types/Merger.html +++ b/types/Merger.html @@ -2,4 +2,4 @@

    Type Parameters

    Type declaration

    Returns

    State that will be put into Vuex.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/Reducer.html b/types/Reducer.html index 4874408ad..0084d9743 100644 --- a/types/Reducer.html +++ b/types/Reducer.html @@ -1,4 +1,4 @@ Reducer | Vuex - Long Term Memory

    Type alias Reducer<S>

    Reducer<S>: ((state) => Partial<S>)

    Removes parts of the state that shouldn't be persisted.

    Type Parameters

    • S

    Type declaration

      • (state): Partial<S>
      • Parameters

        • state: S

          The full state from Vuex.

        Returns Partial<S>

    Returns

    The part of the state that should be persisted.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/SetItem.html b/types/SetItem.html index ebb890410..cb46aafd7 100644 --- a/types/SetItem.html +++ b/types/SetItem.html @@ -3,4 +3,4 @@

    Param: data

    The state to be persisted.

    Typeparam

    T - The storage state type.

    Returns

    Shouldn't return or resolve returned promise before the state is persisted.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/ToInner.html b/types/ToInner.html index b60e05e29..188facc21 100644 --- a/types/ToInner.html +++ b/types/ToInner.html @@ -3,4 +3,4 @@

    Returns Inner

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    Returns

    The state data in inner format.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/ToOuter.html b/types/ToOuter.html index abdd7fd4a..e77d53d62 100644 --- a/types/ToOuter.html +++ b/types/ToOuter.html @@ -3,4 +3,4 @@

    Returns Outer | null

    Typeparam

    Outer - The Vuex state type.

    Typeparam

    Inner - The storage state type.

    Returns

    The state data in outer format.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/localForageDrivers.html b/variables/localForageDrivers.html index 88d4a7025..a7aa89bf5 100644 --- a/variables/localForageDrivers.html +++ b/variables/localForageDrivers.html @@ -1 +1 @@ -localForageDrivers | Vuex - Long Term Memory

    Variable localForageDriversConst

    localForageDrivers: {
        INDEXEDDB: string;
        LOCALSTORAGE: string;
        WEBSQL: string;
    } = ...

    Type declaration

    • INDEXEDDB: string
    • LOCALSTORAGE: string
    • WEBSQL: string
    \ No newline at end of file +localForageDrivers | Vuex - Long Term Memory

    Variable localForageDriversConst

    localForageDrivers: {
        INDEXEDDB: string;
        LOCALSTORAGE: string;
        WEBSQL: string;
    } = ...

    Type declaration

    • INDEXEDDB: string
    • LOCALSTORAGE: string
    • WEBSQL: string
    \ No newline at end of file