diff --git a/docs/functions/index.useRGS.html b/docs/functions/index.useRGS.html index 9c8d3831..75e35003 100644 --- a/docs/functions/index.useRGS.html +++ b/docs/functions/index.useRGS.html @@ -10,4 +10,4 @@

Returns [T, SetStateAction<T>]

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/plugins_persist.persist.html b/docs/functions/plugins_persist.persist.html index 795337ea..d97fd318 100644 --- a/docs/functions/plugins_persist.persist.html +++ b/docs/functions/plugins_persist.persist.html @@ -1,3 +1,3 @@ persist | React18 Global Store

Function persist

A plugin that persists and syncs RGS store between tabs.

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.createHook.html b/docs/functions/utils.createHook.html index 9b068b25..e3fbf70c 100644 --- a/docs/functions/utils.createHook.html +++ b/docs/functions/utils.createHook.html @@ -1,2 +1,2 @@ createHook | React18 Global Store

Function createHook

Extract coomon create hook logic to utils

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.createSetter.html b/docs/functions/utils.createSetter.html index 7cffcf63..0e2d58f3 100644 --- a/docs/functions/utils.createSetter.html +++ b/docs/functions/utils.createSetter.html @@ -1,2 +1,2 @@ createSetter | React18 Global Store

Function createSetter

setter function to set the state.

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.createSubcriber.html b/docs/functions/utils.createSubcriber.html index b9ac1e66..5886e9f2 100644 --- a/docs/functions/utils.createSubcriber.html +++ b/docs/functions/utils.createSubcriber.html @@ -1,2 +1,2 @@ createSubcriber | React18 Global Store

Function createSubcriber

craete subscriber function to subscribe to the store.

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.initWithPlugins.html b/docs/functions/utils.initWithPlugins.html index 5c31ab4f..b9e0d15c 100644 --- a/docs/functions/utils.initWithPlugins.html +++ b/docs/functions/utils.initWithPlugins.html @@ -1,2 +1,2 @@ initWithPlugins | React18 Global Store

Function initWithPlugins

Initialize the named store when invoked for the first time.

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

  • Type Parameters

    • T

    Parameters

    • key: string
    • Optionalvalue: ValueType<T>
    • plugins: Plugin<T>[] = []
    • doNotInit: boolean = false

    Returns void

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/utils.useRGSWithPlugins.html b/docs/functions/utils.useRGSWithPlugins.html index 70dd872b..bd73d159 100644 --- a/docs/functions/utils.useRGSWithPlugins.html +++ b/docs/functions/utils.useRGSWithPlugins.html @@ -12,4 +12,4 @@

Returns [T, SetStateAction<T>]

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/with_plugins.create.html b/docs/functions/with_plugins.create.html index 9128cf66..a951addd 100644 --- a/docs/functions/with_plugins.create.html +++ b/docs/functions/with_plugins.create.html @@ -8,4 +8,4 @@

Returns (() => [T, SetStateAction<T>])

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/functions/with_plugins.withPlugins.html b/docs/functions/with_plugins.withPlugins.html index c32eab93..2fd82ee0 100644 --- a/docs/functions/with_plugins.withPlugins.html +++ b/docs/functions/with_plugins.withPlugins.html @@ -1,4 +1,4 @@ withPlugins | React18 Global Store

Function withPlugins

Creates a hook similar to useRGS, but with plugins to be applied on first invocation.

  • withPlugins<T>(plugins): (<U>(key: string, value?: U, doNotInit?: boolean) => [U, SetStateAction<U>])

  • Type Parameters

    • T

    Parameters

    • plugins: Plugin<T>[]

      Plugins to be applied to the store.

    Returns (<U>(key: string, value?: U, doNotInit?: boolean) => [U, SetStateAction<U>])

    A hook that automatically initializes the store (if not already initialized) with the given plugins.

    -

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/interfaces/plugins_persist.PersistOptions.html b/docs/interfaces/plugins_persist.PersistOptions.html index f07adb6c..76dd6ff9 100644 --- a/docs/interfaces/plugins_persist.PersistOptions.html +++ b/docs/interfaces/plugins_persist.PersistOptions.html @@ -1,9 +1,9 @@ -PersistOptions | React18 Global Store

Interface PersistOptions

interface PersistOptions {
    storage?: "local" | "session" | "cookie";
    sync?: boolean;
}

Properties

storage? +PersistOptions | React18 Global Store

Interface PersistOptions

interface PersistOptions {
    storage?: "local" | "session" | "cookie";
    sync?: boolean;
}

Properties

storage? sync?

Properties

Optionalstorage

storage?: "local" | "session" | "cookie"

Default Value

local
-

Optionalsync

sync?: boolean

Default Value

true
+

Optionalsync

sync?: boolean

Default Value

true
-

Settings

Member Visibility

On This Page

storagesync
\ No newline at end of file +

Settings

Member Visibility

On This Page

storagesync
\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html index 07f1fe34..0dc8c194 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -1,4 +1,4 @@ -index | React18 Global Store

Module index

References

Plugin +index | React18 Global Store

Module index

References

Plugin SetStateAction SetterArgType index diff --git a/docs/modules/plugins_persist.html b/docs/modules/plugins_persist.html index 0cc67948..15015340 100644 --- a/docs/modules/plugins_persist.html +++ b/docs/modules/plugins_persist.html @@ -1,3 +1,3 @@ -plugins/persist | React18 Global Store

Module plugins/persist

Index

Interfaces

PersistOptions +plugins/persist | React18 Global Store

Module plugins/persist

Index

Interfaces

PersistOptions

Functions

persist

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html index 9d89f293..cbe5647b 100644 --- a/docs/modules/utils.html +++ b/docs/modules/utils.html @@ -1,4 +1,4 @@ -utils | React18 Global Store

Module utils

Index

Modules

<internal> +utils | React18 Global Store

Module utils

Index

Modules

<internal>

Type Aliases

Plugin SetStateAction SetterArgType diff --git a/docs/modules/with_plugins.html b/docs/modules/with_plugins.html index 355ad0e4..33f74e87 100644 --- a/docs/modules/with_plugins.html +++ b/docs/modules/with_plugins.html @@ -1,4 +1,4 @@ -with-plugins | React18 Global Store

Module with-plugins

References

useRGSWithPlugins +with-plugins | React18 Global Store

Module with-plugins

References

useRGSWithPlugins

Functions

create withPlugins

References

useRGSWithPlugins

Re-exports useRGSWithPlugins

Settings

Member Visibility

On This Page

useRGSWithPlugins
\ No newline at end of file diff --git a/docs/types/utils.Plugin.html b/docs/types/utils.Plugin.html index a5793bcf..8635a2e0 100644 --- a/docs/types/utils.Plugin.html +++ b/docs/types/utils.Plugin.html @@ -1 +1 @@ -Plugin | React18 Global Store

Type Alias Plugin<T>

Plugin<T>: {
    init?: ((key: string, value: T | undefined, mutate: Mutate<T>) => void);
    onChange?: ((key: string, value?: T) => void);
}

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file +Plugin | React18 Global Store

Type Alias Plugin<T>

Plugin<T>: {
    init?: ((key: string, value: T | undefined, mutate: Mutate<T>) => void);
    onChange?: ((key: string, value?: T) => void);
}

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils.SetStateAction.html b/docs/types/utils.SetStateAction.html index 71045f7f..8e49130c 100644 --- a/docs/types/utils.SetStateAction.html +++ b/docs/types/utils.SetStateAction.html @@ -1 +1 @@ -SetStateAction | React18 Global Store

Type Alias SetStateAction<T>

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

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file +SetStateAction | React18 Global Store

Type Alias SetStateAction<T>

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

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils.SetterArgType.html b/docs/types/utils.SetterArgType.html index a34a057a..ac31f038 100644 --- a/docs/types/utils.SetterArgType.html +++ b/docs/types/utils.SetterArgType.html @@ -1 +1 @@ -SetterArgType | React18 Global Store

Type Alias SetterArgType<T>

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

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file +SetterArgType | React18 Global Store

Type Alias SetterArgType<T>

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

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils.ValueType.html b/docs/types/utils.ValueType.html index 7ea7d972..7d11994b 100644 --- a/docs/types/utils.ValueType.html +++ b/docs/types/utils.ValueType.html @@ -1 +1 @@ -ValueType | React18 Global Store

Type Alias ValueType<T>

ValueType<T>: T | (() => T)

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file +ValueType | React18 Global Store

Type Alias ValueType<T>

ValueType<T>: T | (() => T)

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils._internal_.Listener.html b/docs/types/utils._internal_.Listener.html index 74dca3c1..60ca4f50 100644 --- a/docs/types/utils._internal_.Listener.html +++ b/docs/types/utils._internal_.Listener.html @@ -1 +1 @@ -Listener | React18 Global Store

Type Alias Listener

Listener: (() => void)

Settings

Member Visibility
\ No newline at end of file +Listener | React18 Global Store

Type Alias Listener

Listener: (() => void)

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils._internal_.Mutate.html b/docs/types/utils._internal_.Mutate.html index 640c153f..d12600b1 100644 --- a/docs/types/utils._internal_.Mutate.html +++ b/docs/types/utils._internal_.Mutate.html @@ -1 +1 @@ -Mutate | React18 Global Store

Type Alias Mutate<T>

Mutate<T>: ((value?: T) => void)

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file +Mutate | React18 Global Store

Type Alias Mutate<T>

Mutate<T>: ((value?: T) => void)

Type Parameters

  • T

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils._internal_.RGS.html b/docs/types/utils._internal_.RGS.html index e3011acc..467a8ed6 100644 --- a/docs/types/utils._internal_.RGS.html +++ b/docs/types/utils._internal_.RGS.html @@ -1,2 +1,2 @@ RGS | React18 Global Store

Type Alias RGS

RGS: {
    l: Listener[];
    s: SetStateAction<unknown> | null;
    u: Subscriber;
    v: unknown;
}

This is a hack to reduce lib size + readability + not encouraging direct access to globalThis

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/types/utils._internal_.Subscriber.html b/docs/types/utils._internal_.Subscriber.html index bff98dc3..7e79348f 100644 --- a/docs/types/utils._internal_.Subscriber.html +++ b/docs/types/utils._internal_.Subscriber.html @@ -1 +1 @@ -Subscriber | React18 Global Store

Type Alias Subscriber

Subscriber: ((l: Listener) => (() => void))

Settings

Member Visibility
\ No newline at end of file +Subscriber | React18 Global Store

Type Alias Subscriber

Subscriber: ((l: Listener) => (() => void))

Settings

Member Visibility
\ No newline at end of file diff --git a/docs/variables/utils.globalRGS.html b/docs/variables/utils.globalRGS.html index 90d85942..d688d170 100644 --- a/docs/variables/utils.globalRGS.html +++ b/docs/variables/utils.globalRGS.html @@ -1 +1 @@ -globalRGS | React18 Global Store

Variable globalRGSConst

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

Settings

Member Visibility
\ No newline at end of file +globalRGS | React18 Global Store

Variable globalRGSConst

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

Settings

Member Visibility
\ No newline at end of file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 65389c33..98397ed7 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -2038,8 +2038,8 @@ packages: resolution: {integrity: sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==} engines: {node: '>=16'} - caniuse-lite@1.0.30001637: - resolution: {integrity: sha512-1x0qRI1mD1o9e+7mBI7XtzFAP4XszbHaVWsMiGbSPLYekKTJF7K+FNk6AsXH4sUpc+qrsI3pVgf1Jdl/uGkuSQ==} + caniuse-lite@1.0.30001638: + resolution: {integrity: sha512-5SuJUJ7cZnhPpeLHaH0c/HPAnAHZvS6ElWyHK9GSIbVOQABLzowiI2pjmpvZ1WEbkyz46iFd4UXlOHR5SqgfMQ==} capital-case@1.0.4: resolution: {integrity: sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==} @@ -8183,7 +8183,7 @@ snapshots: autoprefixer@10.4.19(postcss@8.4.38): dependencies: browserslist: 4.23.1 - caniuse-lite: 1.0.30001637 + caniuse-lite: 1.0.30001638 fraction.js: 4.3.7 normalize-range: 0.1.2 picocolors: 1.0.1 @@ -8315,7 +8315,7 @@ snapshots: browserslist@4.23.1: dependencies: - caniuse-lite: 1.0.30001637 + caniuse-lite: 1.0.30001638 electron-to-chromium: 1.4.812 node-releases: 2.0.14 update-browserslist-db: 1.0.16(browserslist@4.23.1) @@ -8387,7 +8387,7 @@ snapshots: camelcase@8.0.0: {} - caniuse-lite@1.0.30001637: {} + caniuse-lite@1.0.30001638: {} capital-case@1.0.4: dependencies: @@ -11594,7 +11594,7 @@ snapshots: '@next/env': 14.2.4 '@swc/helpers': 0.5.5 busboy: 1.6.0 - caniuse-lite: 1.0.30001637 + caniuse-lite: 1.0.30001638 graceful-fs: 4.2.11 postcss: 8.4.31 react: 18.3.1