diff --git a/docs/functions/plugins_persist_and_sync.default.html b/docs/functions/plugins_persist_and_sync.default.html index 1bde7672..f40063e9 100644 --- a/docs/functions/plugins_persist_and_sync.default.html +++ b/docs/functions/plugins_persist_and_sync.default.html @@ -1,3 +1,3 @@ default | Code Documentation

Function default

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/use_rgs.default.html b/docs/functions/use_rgs.default.html index 96c01b9c..7df64583 100644 --- a/docs/functions/use_rgs.default.html +++ b/docs/functions/use_rgs.default.html @@ -10,4 +10,4 @@

Example

const [state, setState] = useRGS<number>("counter", 1);
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createHook.html b/docs/functions/utils.createHook.html index 4a984ce3..45b44b9d 100644 --- a/docs/functions/utils.createHook.html +++ b/docs/functions/utils.createHook.html @@ -1,2 +1,2 @@ createHook | Code Documentation

Function createHook

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns [T, SetStateAction<T>]

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSetter.html b/docs/functions/utils.createSetter.html index 3711eefa..c5c992c6 100644 --- a/docs/functions/utils.createSetter.html +++ b/docs/functions/utils.createSetter.html @@ -1,2 +1,2 @@ createSetter | Code Documentation

Function createSetter

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns SetStateAction<unknown>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.createSubcriber.html b/docs/functions/utils.createSubcriber.html index 0e0712af..07f070b9 100644 --- a/docs/functions/utils.createSubcriber.html +++ b/docs/functions/utils.createSubcriber.html @@ -1,2 +1,2 @@ createSubcriber | Code Documentation

Function createSubcriber

  • createSubcriber(key): Subscriber

  • craete subscriber function to subscribe to the store.

    -

    Parameters

    • key: string

    Returns Subscriber

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns Subscriber

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/utils.initWithPlugins.html b/docs/functions/utils.initWithPlugins.html index e108b4a4..71f4720d 100644 --- a/docs/functions/utils.initWithPlugins.html +++ b/docs/functions/utils.initWithPlugins.html @@ -1,2 +1,2 @@ initWithPlugins | Code Documentation

Function initWithPlugins

  • initWithPlugins<T>(key, value?, serverValue?, plugins?): void

  • Initialize the named store when invoked for the first time.

    -

    Type Parameters

    • T

    Parameters

    • key: string
    • Optional value: T
    • Optional serverValue: T
    • plugins: Plugin<T>[] = []

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +

Type Parameters

Parameters

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.create.html b/docs/functions/with_plugins.create.html index 339f716c..1e4cb981 100644 --- a/docs/functions/with_plugins.create.html +++ b/docs/functions/with_plugins.create.html @@ -11,4 +11,4 @@

Example

// in hook file
export const useRGS = create<type>(key, value, serverValue, plugins);

// in component file
const [state, setState] = useRGS();
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/with_plugins.useRGSWithPlugins.html b/docs/functions/with_plugins.useRGSWithPlugins.html index 0cc567fb..3bbfa6fa 100644 --- a/docs/functions/with_plugins.useRGSWithPlugins.html +++ b/docs/functions/with_plugins.useRGSWithPlugins.html @@ -11,4 +11,4 @@

Example

const [state, setState] = useRGS<number>("counter", 1);
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index d85cefa5..c3af7fcf 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | Code Documentation

Module index

References

Plugin +index | Code Documentation

Module index

References

Plugin SetStateAction SetterArgType default diff --git a/docs/modules/plugins_persist_and_sync.html b/docs/modules/plugins_persist_and_sync.html index 27f1c1a8..721ee715 100644 --- a/docs/modules/plugins_persist_and_sync.html +++ b/docs/modules/plugins_persist_and_sync.html @@ -1,2 +1,2 @@ -plugins/persist-and-sync | Code Documentation

Module plugins/persist-and-sync

Index

Functions

default +plugins/persist-and-sync | Code Documentation

Module plugins/persist-and-sync

Index

Functions

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/use_rgs.html b/docs/modules/use_rgs.html index 337009ed..3b9f08a7 100644 --- a/docs/modules/use_rgs.html +++ b/docs/modules/use_rgs.html @@ -1,2 +1,2 @@ -use-rgs | Code Documentation

Module use-rgs

Index

Functions

default +use-rgs | Code Documentation

Module use-rgs

Index

Functions

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 993692ea..92a05457 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,4 +1,4 @@ -utils | Code Documentation

Module utils

Index

Type Aliases

Plugin +utils | Code Documentation

Module utils

Index

Type Aliases

Plugin SetStateAction SetterArgType

Variables

globalRGS diff --git a/docs/modules/with_plugins.html b/docs/modules/with_plugins.html index 4be62611..eeb53c28 100644 --- a/docs/modules/with_plugins.html +++ b/docs/modules/with_plugins.html @@ -1,3 +1,3 @@ -with-plugins | Code Documentation

Module with-plugins

Index

Functions

create +with-plugins | Code Documentation

Module with-plugins

Index

Functions

create useRGSWithPlugins

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.Plugin.html b/docs/types/utils.Plugin.html index 789e51ca..379cc298 100644 --- a/docs/types/utils.Plugin.html +++ b/docs/types/utils.Plugin.html @@ -1 +1 @@ -Plugin | Code Documentation

Type alias Plugin<T>

Plugin<T>: {
    init?: ((key, value, serverValue, mutate) => void);
    onChange?: ((key, value?, serverValue?) => void);
}

Type Parameters

  • T

Type declaration

  • Optional init?: ((key, value, serverValue, mutate) => void)
      • (key, value, serverValue, mutate): void

      • Parameters

        • key: string
        • value: T | undefined
        • serverValue: T | undefined
        • mutate: Mutate<T>

        Returns void

  • Optional onChange?: ((key, value?, serverValue?) => void)
      • (key, value?, serverValue?): void

      • Parameters

        • key: string
        • Optional value: T
        • Optional serverValue: T

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +Plugin | Code Documentation

Type alias Plugin<T>

Plugin<T>: {
    init?: ((key, value, serverValue, mutate) => void);
    onChange?: ((key, value?, serverValue?) => void);
}

Type Parameters

  • T

Type declaration

  • Optional init?: ((key, value, serverValue, mutate) => void)
      • (key, value, serverValue, mutate): void

      • Parameters

        • key: string
        • value: T | undefined
        • serverValue: T | undefined
        • mutate: Mutate<T>

        Returns void

  • Optional onChange?: ((key, value?, serverValue?) => void)
      • (key, value?, serverValue?): void

      • Parameters

        • key: string
        • Optional value: T
        • Optional serverValue: T

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetStateAction.html b/docs/types/utils.SetStateAction.html index c85e0772..48d76aab 100644 --- a/docs/types/utils.SetStateAction.html +++ b/docs/types/utils.SetStateAction.html @@ -1 +1 @@ -SetStateAction | Code Documentation

Type alias SetStateAction<T>

SetStateAction<T>: ((value) => void)

Type Parameters

  • T

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file +SetStateAction | Code Documentation

Type alias SetStateAction<T>

SetStateAction<T>: ((value) => void)

Type Parameters

  • T

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/utils.SetterArgType.html b/docs/types/utils.SetterArgType.html index 5214130d..220f7fda 100644 --- a/docs/types/utils.SetterArgType.html +++ b/docs/types/utils.SetterArgType.html @@ -1 +1 @@ -SetterArgType | Code Documentation

Type alias SetterArgType<T>

SetterArgType<T>: T | ((prevState) => T)

Type Parameters

  • T

Type declaration

    • (prevState): T

    • Parameters

      • prevState: T

      Returns T

Settings

Member Visibility

Theme

\ No newline at end of file +SetterArgType | Code Documentation

Type alias SetterArgType<T>

SetterArgType<T>: T | ((prevState) => T)

Type Parameters

  • T

Type declaration

    • (prevState): T

    • Parameters

      • prevState: T

      Returns T

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/variables/utils.globalRGS.html b/docs/variables/utils.globalRGS.html index 60f812ac..3d6b9b30 100644 --- a/docs/variables/utils.globalRGS.html +++ b/docs/variables/utils.globalRGS.html @@ -1 +1 @@ -globalRGS | Code Documentation

Variable globalRGSConst

globalRGS: Record<string, undefined | RGS> = globalThisForBetterMinification.rgs

Settings

Member Visibility

Theme

\ No newline at end of file +globalRGS | Code Documentation

Variable globalRGSConst

globalRGS: Record<string, undefined | RGS> = globalThisForBetterMinification.rgs

Settings

Member Visibility

Theme

\ No newline at end of file