From 27229f30ac7be05103b9ad8204d3c86828cd0dc5 Mon Sep 17 00:00:00 2001 From: Reimagined Palm Tree Date: Thu, 4 Apr 2024 01:10:37 +0000 Subject: [PATCH] docs: update --- classes/GenericStorageWrapper.html | 4 ++-- classes/LTM.html | 8 ++++---- functions/chromeLocalStorage.html | 2 +- functions/chromeStorageWrapper.html | 2 +- functions/chromeSyncStorage.html | 2 +- functions/configurableDeepMerge.html | 2 +- functions/deepMerge.html | 2 +- functions/dummyFilter.html | 2 +- functions/executeWithDelay.html | 2 +- functions/inMemoryStorage.html | 2 +- functions/localForage-1.html | 2 +- functions/localForageWrapper.html | 2 +- functions/localStorage.html | 2 +- functions/localStorageWrapper.html | 2 +- functions/mutationFilter.html | 2 +- functions/pickModules.html | 2 +- functions/replace.html | 2 +- functions/saveAll.html | 2 +- functions/sessionStorage.html | 2 +- functions/shallowMerge.html | 2 +- functions/simplyExecute.html | 2 +- interfaces/AsyncStorage.html | 4 ++-- interfaces/ChromeStorage.html | 4 ++-- interfaces/LTMConfig.html | 4 ++-- interfaces/LocalForage.html | 4 ++-- interfaces/StorageItems.html | 2 +- interfaces/StringStorage.html | 4 ++-- types/Executor.html | 2 +- types/Filter.html | 2 +- types/GetItem.html | 2 +- types/Merger.html | 2 +- types/Reducer.html | 2 +- types/SetItem.html | 2 +- types/ToInner.html | 2 +- types/ToOuter.html | 2 +- variables/localForageDrivers.html | 2 +- 36 files changed, 45 insertions(+), 45 deletions(-) diff --git a/classes/GenericStorageWrapper.html b/classes/GenericStorageWrapper.html index be3d96d42..71cffe087 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

constructor +

Type Parameters

Implements

Constructors

constructor

Methods

load save -

Constructors

constructor

Methods

load

save

Settings

Member Visibility

Theme

On This Page

constructorloadsave

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

load

save

Settings

Member Visibility

Theme

On This Page

constructorloadsave

Generated using TypeDoc

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

Class LTM<S>

Long Term Memory main class.

Typeparam

S - Vuex state type.

-

Type Parameters

  • S

Constructors

constructor +

Type Parameters

  • S

Constructors

constructor

Properties

ready

Accessors

plugin -

Constructors

constructor

Properties

Readonly ready

ready: Promise<void>

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

-

Accessors

plugin

  • get plugin(): Plugin<S>

  • Vuex plugin (i.e. new Vuex.Store({ plugins: [ltm.plugin] })).

    -

    Returns Plugin<S>

Settings

Member Visibility

Theme

On This Page

constructorreadyplugin

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Readonly ready

ready: Promise<void>

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

+

Accessors

plugin

  • get plugin(): Plugin<S>

  • Vuex plugin (i.e. new Vuex.Store({ plugins: [ltm.plugin] })).

    +

    Returns Plugin<S>

Settings

Member Visibility

Theme

On This Page

constructorreadyplugin

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/chromeLocalStorage.html b/functions/chromeLocalStorage.html index 8899ffe1d..dc6e2486c 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/chromeStorageWrapper.html b/functions/chromeStorageWrapper.html index a98947976..c28374f93 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/chromeSyncStorage.html b/functions/chromeSyncStorage.html index d2121c710..ca7742f87 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function configurableDeepMerge

    • configurableDeepMerge<S>(options): Merger<S>

    • 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.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/deepMerge.html b/functions/deepMerge.html index b3325858a..929b62078 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/dummyFilter.html b/functions/dummyFilter.html index 0de657c25..34e59f7f4 100644 --- a/functions/dummyFilter.html +++ b/functions/dummyFilter.html @@ -1,3 +1,3 @@ dummyFilter | Vuex - Long Term Memory

    Function dummyFilter

    • dummyFilter(): boolean

    • Persists everything

      Returns boolean

      Always true.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/executeWithDelay.html b/functions/executeWithDelay.html index 5c27eb00a..3dc742f54 100644 --- a/functions/executeWithDelay.html +++ b/functions/executeWithDelay.html @@ -1,4 +1,4 @@ executeWithDelay | Vuex - Long Term Memory

    Function executeWithDelay

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/inMemoryStorage.html b/functions/inMemoryStorage.html index b0942b9cc..27b97fecc 100644 --- a/functions/inMemoryStorage.html +++ b/functions/inMemoryStorage.html @@ -1,4 +1,4 @@ inMemoryStorage | Vuex - Long Term Memory

    Function inMemoryStorage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/localForage-1.html b/functions/localForage-1.html index b2da315fa..15d078b6a 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/localForageWrapper.html b/functions/localForageWrapper.html index f0e0b166f..1c3c9b8f7 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/localStorage.html b/functions/localStorage.html index fed4afa3d..fdae926c1 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/localStorageWrapper.html b/functions/localStorageWrapper.html index 8950b0604..f6a3f33db 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/mutationFilter.html b/functions/mutationFilter.html index ee3140ab8..e33506f6a 100644 --- a/functions/mutationFilter.html +++ b/functions/mutationFilter.html @@ -1,3 +1,3 @@ mutationFilter | Vuex - Long Term Memory

    Function mutationFilter

    • mutationFilter(mutations): Filter

    • Builds a filter that filters mutations by given types.

      Parameters

      • mutations: (string | RegExp)[]

        Mutation types that should trigger persisting.

        -

      Returns Filter

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Filter

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/pickModules.html b/functions/pickModules.html index bd96c91fd..7a8d90a28 100644 --- a/functions/pickModules.html +++ b/functions/pickModules.html @@ -1,3 +1,3 @@ pickModules | Vuex - Long Term Memory

    Function pickModules

    • pickModules<S>(moduleNames): Reducer<S>

    • 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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Reducer<S>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/replace.html b/functions/replace.html index 63050d9ba..6e264a79d 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.

    -
  • replace<S>(loaded): S

  • Type Parameters

    • S

    Parameters

    • loaded: Partial<S>

    Returns S

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • replace<S>(loaded): S

  • Type Parameters

    • S

    Parameters

    • loaded: Partial<S>

    Returns S

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function saveAll

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns S

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/sessionStorage.html b/functions/sessionStorage.html index 6a3ddf8fb..9c9ff601e 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/shallowMerge.html b/functions/shallowMerge.html index 410377511..9111de2ca 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/simplyExecute.html b/functions/simplyExecute.html index 02897b572..dcea1abe9 100644 --- a/functions/simplyExecute.html +++ b/functions/simplyExecute.html @@ -1,2 +1,2 @@ simplyExecute | Vuex - Long Term Memory

    Function simplyExecute

    • simplyExecute(func): void

    • Persists the state immediatelly.

      -

      Parameters

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

          • Returns void

      Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/AsyncStorage.html b/interfaces/AsyncStorage.html index 4f21feec3..738b07ee6 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

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

    Type Parameters

    • T

    Implemented by

    Methods

    load save -

    Methods

    load

    save

    Settings

    Member Visibility

    Theme

    On This Page

    loadsave

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    load

    save

    Settings

    Member Visibility

    Theme

    On This Page

    loadsave

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ChromeStorage.html b/interfaces/ChromeStorage.html index a076f6bbc..7a6d0eca3 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

    get set -

    Methods

    get

    set

    Settings

    Member Visibility

    Theme

    On This Page

    getset

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    get

    set

    Settings

    Member Visibility

    Theme

    On This Page

    getset

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/LTMConfig.html b/interfaces/LTMConfig.html index eef3a5aad..67ea987a6 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 filter merge reduce storage -

    Properties

    execute

    execute: Executor

    filter

    filter: Filter

    merge

    merge: Merger<S>

    reduce

    reduce: Reducer<S>

    storage

    storage: AsyncStorage<Partial<S>>

    Settings

    Member Visibility

    Theme

    On This Page

    executefiltermergereducestorage

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    execute

    execute: Executor

    filter

    filter: Filter

    merge

    merge: Merger<S>

    reduce

    reduce: Reducer<S>

    storage

    storage: AsyncStorage<Partial<S>>

    Settings

    Member Visibility

    Theme

    On This Page

    executefiltermergereducestorage

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/LocalForage.html b/interfaces/LocalForage.html index e303c6da3..c610ad52a 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

    getItem setItem -

    Methods

    getItem

    setItem

    Settings

    Member Visibility

    Theme

    On This Page

    getItemsetItem

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    getItem

    setItem

    Settings

    Member Visibility

    Theme

    On This Page

    getItemsetItem

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/StorageItems.html b/interfaces/StorageItems.html index bb3c8c2a7..6e09abd8d 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/StringStorage.html b/interfaces/StringStorage.html index ec2ea27a6..8d0024d07 100644 --- a/interfaces/StringStorage.html +++ b/interfaces/StringStorage.html @@ -1,4 +1,4 @@ StringStorage | Vuex - Long Term Memory

    Interface StringStorage

    Required subset of localStorage API by localStorageWrapper.

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

    Methods

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

    Methods

    getItem setItem -

    Methods

    getItem

    setItem

    Settings

    Member Visibility

    Theme

    On This Page

    getItemsetItem

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    getItem

    setItem

    Settings

    Member Visibility

    Theme

    On This Page

    getItemsetItem

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Executor.html b/types/Executor.html index 9b61844c9..d079fa4f9 100644 --- a/types/Executor.html +++ b/types/Executor.html @@ -1,3 +1,3 @@ Executor | Vuex - Long Term Memory

    Type alias Executor

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Filter.html b/types/Filter.html index e16dd6617..a838a97fb 100644 --- a/types/Filter.html +++ b/types/Filter.html @@ -1,4 +1,4 @@ Filter | Vuex - Long Term Memory

    Type alias Filter

    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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/GetItem.html b/types/GetItem.html index b9ac55169..fe8d196a6 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Merger.html b/types/Merger.html index 93acaff54..e5645b759 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Reducer.html b/types/Reducer.html index a9c8e6a1e..f1c91ee9f 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/SetItem.html b/types/SetItem.html index c0d81d54c..4e7704169 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ToInner.html b/types/ToInner.html index 380cba2d9..837f51508 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/ToOuter.html b/types/ToOuter.html index ed46592ab..b0faef754 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/localForageDrivers.html b/variables/localForageDrivers.html index 6b7813a0e..483866d8c 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file