From 72564954e9c1ed87751f38eeb781f167f2a99dab Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Wed, 11 Dec 2024 08:23:19 +0000 Subject: [PATCH] upgrade deps && docs --- docs/functions/index.useRGS.html | 2 +- docs/functions/plugins_persist.persist.html | 2 +- docs/functions/utils.createHook.html | 2 +- docs/functions/utils.createSetter.html | 2 +- docs/functions/utils.createSubcriber.html | 2 +- docs/functions/utils.initWithPlugins.html | 2 +- docs/functions/utils.useRGSWithPlugins.html | 2 +- docs/functions/with-plugins.create.html | 2 +- docs/functions/with-plugins.withPlugins.html | 2 +- .../plugins_persist.PersistOptions.html | 6 +++--- docs/types/utils.Plugin.html | 2 +- docs/types/utils.SetStateAction.html | 2 +- docs/types/utils.SetterArgType.html | 2 +- docs/types/utils.ValueType.html | 2 +- docs/types/utils._internal_.Listener.html | 2 +- docs/types/utils._internal_.Mutate.html | 2 +- docs/types/utils._internal_.RGS.html | 2 +- docs/types/utils._internal_.Subscriber.html | 2 +- docs/variables/utils.globalRGS.html | 2 +- pnpm-lock.yaml | 20 +++++++++---------- 20 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/functions/index.useRGS.html b/docs/functions/index.useRGS.html index d8083a6e..1f697c0d 100644 --- a/docs/functions/index.useRGS.html +++ b/docs/functions/index.useRGS.html @@ -10,4 +10,4 @@

Returns [T, SetStateAction<T>]

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/plugins_persist.persist.html b/docs/functions/plugins_persist.persist.html index 2a1e3ae3..6bf6efcd 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
+

Settings

Member Visibility
diff --git a/docs/functions/utils.createHook.html b/docs/functions/utils.createHook.html index e5a9ded5..d381cc1d 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
+

Settings

Member Visibility
diff --git a/docs/functions/utils.createSetter.html b/docs/functions/utils.createSetter.html index 3c256a38..45307d74 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
+

Settings

Member Visibility
diff --git a/docs/functions/utils.createSubcriber.html b/docs/functions/utils.createSubcriber.html index 82d52656..57d1d455 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
+

Settings

Member Visibility
diff --git a/docs/functions/utils.initWithPlugins.html b/docs/functions/utils.initWithPlugins.html index 9e28db26..92cfdb32 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: string,
        value?: ValueType<T>,
        plugins?: Plugin<T>[],
        doNotInit?: boolean,
    ): void

  • Type Parameters

    • T

    Parameters

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

    Returns void

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/utils.useRGSWithPlugins.html b/docs/functions/utils.useRGSWithPlugins.html index 95e1decd..6b69e5b9 100644 --- a/docs/functions/utils.useRGSWithPlugins.html +++ b/docs/functions/utils.useRGSWithPlugins.html @@ -12,4 +12,4 @@

Returns [T, SetStateAction<T>]

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/functions/with-plugins.create.html b/docs/functions/with-plugins.create.html index 6c287819..a39a368a 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
+

Settings

Member Visibility
diff --git a/docs/functions/with-plugins.withPlugins.html b/docs/functions/with-plugins.withPlugins.html index 5d84847b..f3bc5f04 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: Plugin<T>[],
    ): <U = T>(
        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 = T>(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
+

Settings

Member Visibility
diff --git a/docs/interfaces/plugins_persist.PersistOptions.html b/docs/interfaces/plugins_persist.PersistOptions.html index d9581c07..4f37b454 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

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/utils.Plugin.html b/docs/types/utils.Plugin.html index 9dd1e7a9..5bf0c692 100644 --- a/docs/types/utils.Plugin.html +++ b/docs/types/utils.Plugin.html @@ -1 +1 @@ -Plugin | React18 Global Store

Type Alias Plugin<T>

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

Type Parameters

  • T

Settings

Member Visibility
+Plugin | React18 Global Store

Type Alias Plugin<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/utils.SetStateAction.html b/docs/types/utils.SetStateAction.html index 124ff0b3..9be2a79f 100644 --- a/docs/types/utils.SetStateAction.html +++ b/docs/types/utils.SetStateAction.html @@ -1 +1 @@ -SetStateAction | React18 Global Store

Type Alias SetStateAction<T>

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

Type Parameters

  • T

Settings

Member Visibility
+SetStateAction | React18 Global Store

Type Alias SetStateAction<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/utils.SetterArgType.html b/docs/types/utils.SetterArgType.html index 3c94e646..592bffeb 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 | (prevState: T) => T

Type Parameters

  • T

Settings

Member Visibility
+SetterArgType | React18 Global Store

Type Alias SetterArgType<T>

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

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/utils.ValueType.html b/docs/types/utils.ValueType.html index 3c6d07ca..7b87c317 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

Type Parameters

  • T

Settings

Member Visibility
+ValueType | React18 Global Store

Type Alias ValueType<T>

ValueType: T | () => T

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/utils._internal_.Listener.html b/docs/types/utils._internal_.Listener.html index 6dd864e8..7c228a14 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
+Listener | React18 Global Store

Type Alias Listener

Listener: () => void

Settings

Member Visibility
diff --git a/docs/types/utils._internal_.Mutate.html b/docs/types/utils._internal_.Mutate.html index c317c6d3..8fd36571 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: (value?: T) => void

Type Parameters

  • T

Settings

Member Visibility
+Mutate | React18 Global Store

Type Alias Mutate<T>

Mutate: (value?: T) => void

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/types/utils._internal_.RGS.html b/docs/types/utils._internal_.RGS.html index 95271ebb..68e4ad48 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
+

Settings

Member Visibility
diff --git a/docs/types/utils._internal_.Subscriber.html b/docs/types/utils._internal_.Subscriber.html index dff8069c..9d3b8069 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
+Subscriber | React18 Global Store

Type Alias Subscriber

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

Settings

Member Visibility
diff --git a/docs/variables/utils.globalRGS.html b/docs/variables/utils.globalRGS.html index c5b5976e..8477cde2 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
+globalRGS | React18 Global Store

Variable globalRGSConst

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

Settings

Member Visibility
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5cf8e161..492449e2 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1838,8 +1838,8 @@ packages: '@shikijs/types@1.24.2': resolution: {integrity: sha512-bdeWZiDtajGLG9BudI0AHet0b6e7FbR0EsE4jpGaI0YwHm/XJunI9+3uZnzFtX65gsyJ6ngCIWUfA4NWRPnBkQ==} - '@shikijs/vscode-textmate@9.3.0': - resolution: {integrity: sha512-jn7/7ky30idSkd/O5yDBfAnVt+JJpepofP/POZ1iMOxK59cOfqIgg/Dj0eFsjOTMw+4ycJN0uhZH/Eb0bs/EUA==} + '@shikijs/vscode-textmate@9.3.1': + resolution: {integrity: sha512-79QfK1393x9Ho60QFyLti+QfdJzRQCVLFb97kOIV7Eo9vQU/roINgk7m24uv0a7AUvN//RDH36FLjjK48v0s9g==} '@sinclair/typebox@0.27.8': resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==} @@ -1985,8 +1985,8 @@ packages: peerDependencies: '@types/react': ^19.0.0 - '@types/react@18.3.15': - resolution: {integrity: sha512-XQzbwkCwrsabawgWsvDDwsDTRuH1sf6Uj1fnFYoG03ZXfT54/aBvlylKR9ix70pXAtTn8dFzj358zVcZN4m83w==} + '@types/react@18.3.16': + resolution: {integrity: sha512-oh8AMIC4Y2ciKufU8hnKgs+ufgbA/dhPTACaZPM86AbwX9QwnFtSoPWEeRUj8fge+v6kFt78BXcDhAU1SrrAsw==} '@types/react@19.0.1': resolution: {integrity: sha512-YW6614BDhqbpR5KtUYzTA+zlA7nayzJRA9ljz9CQoxthR0sDisYZLuvSMsil36t4EH/uAt8T52Xb4sVw17G+SQ==} @@ -7579,7 +7579,7 @@ snapshots: dependencies: '@shikijs/engine-oniguruma': 1.24.2 '@shikijs/types': 1.24.2 - '@shikijs/vscode-textmate': 9.3.0 + '@shikijs/vscode-textmate': 9.3.1 '@humanfs/core@0.19.1': {} @@ -8314,7 +8314,7 @@ snapshots: dependencies: '@remix-run/router': 1.3.1 '@types/cookie': 0.4.1 - '@types/react': 18.3.15 + '@types/react': 18.3.16 '@web3-storage/multipart-parser': 1.0.0 cookie: 0.4.2 set-cookie-parser: 2.7.1 @@ -8424,14 +8424,14 @@ snapshots: '@shikijs/engine-oniguruma@1.24.2': dependencies: '@shikijs/types': 1.24.2 - '@shikijs/vscode-textmate': 9.3.0 + '@shikijs/vscode-textmate': 9.3.1 '@shikijs/types@1.24.2': dependencies: - '@shikijs/vscode-textmate': 9.3.0 + '@shikijs/vscode-textmate': 9.3.1 '@types/hast': 3.0.4 - '@shikijs/vscode-textmate@9.3.0': {} + '@shikijs/vscode-textmate@9.3.1': {} '@sinclair/typebox@0.27.8': optional: true @@ -8599,7 +8599,7 @@ snapshots: dependencies: '@types/react': 19.0.1 - '@types/react@18.3.15': + '@types/react@18.3.16': dependencies: '@types/prop-types': 15.7.14 csstype: 3.1.3