From da1206459b30b261a162d4c738d3d67441659244 Mon Sep 17 00:00:00 2001 From: mayank1513 Date: Tue, 10 Dec 2024 16:22:30 +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 | 40 +++++++++---------- 20 files changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/functions/index.useRGS.html b/docs/functions/index.useRGS.html index b46606c8..6577ec4d 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 17470fd0..34b137bf 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 ae54f092..f0e4efa8 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 63dca72e..64921335 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 ea99bf1f..95e043f0 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 b8d0e0a5..459f7693 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 64c4df17..ddc973b3 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 050f5196..c3cdc093 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 7f7a508d..2ec2918c 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 5e8d590f..e94d818d 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 6f54e315..3d5eeb30 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 a2baa84c..e1e0c3f8 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 83f1e95d..c21860c9 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 a92ae6d8..77a07046 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 c5f61db9..3e38e06a 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 74af57cb..60957f52 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 c9bf14c4..097c5da2 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 c3e1eaf4..830d8ac7 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 a3bf8a9a..340d74d7 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 bf940cad..4e5ecece 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1832,11 +1832,11 @@ packages: '@rushstack/eslint-patch@1.10.4': resolution: {integrity: sha512-WJgX9nzTqknM393q1QJDJmoW28kUfEnybeTfVNcNAPnIx210RXm2DiXiHzfNPJNIUUb1tJnz/l4QGtJ30PgWmA==} - '@shikijs/engine-oniguruma@1.24.1': - resolution: {integrity: sha512-KdrTIBIONWd+Xs61eh8HdIpfigtrseat9dpARvaOe2x0g/FNTbwbkGr3y92VSOVD1XotzEskh3v/nCzyWjkf7g==} + '@shikijs/engine-oniguruma@1.24.2': + resolution: {integrity: sha512-ZN6k//aDNWRJs1uKB12pturKHh7GejKugowOFGAuG7TxDRLod1Bd5JhpOikOiFqPmKjKEPtEA6mRCf7q3ulDyQ==} - '@shikijs/types@1.24.1': - resolution: {integrity: sha512-ZwZFbShFY/APfKNt3s9Gv8rhTm29GodSKsOW66X6N+HGsZuaHalE1VUEX4fv93UXHTZTLjb3uxn63F96RhGfXw==} + '@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==} @@ -4476,8 +4476,8 @@ packages: resolution: {integrity: sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==} hasBin: true - magic-string@0.30.14: - resolution: {integrity: sha512-5c99P1WKTed11ZC0HMJOj6CDIue6F8ySu+bJL+85q1zBEIY8IklrJ1eiKC2NDRh3Ct3FcvmJPyQHb9erXMTJNw==} + magic-string@0.30.15: + resolution: {integrity: sha512-zXeaYRgZ6ldS1RJJUrMrYgNJ4fdwnyI6tVqoiIhyCyv5IVTK9BU8Ic2l253GGETQHxI4HNUwhJ3fjDhKqEoaAw==} magicast@0.3.5: resolution: {integrity: sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==} @@ -4964,8 +4964,8 @@ packages: resolution: {integrity: sha512-lKFSRSRuDHhwDKMUobdsvaWCbbDRbV3jMUSMiajQSQux1aNUevAZVxUHc2JERI//W8ABPRbi3ebYuSuIzkNIpQ==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} - node-releases@2.0.18: - resolution: {integrity: sha512-d9VeXT4SJ7ZeOqGX6R5EM022wpL+eWPooLI+5UpWn2jCT1aosUQEhQP214x33Wkwx3JQMvIm+tIoVOdodFS40g==} + node-releases@2.0.19: + resolution: {integrity: sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==} nopt@7.2.1: resolution: {integrity: sha512-taM24ViiimT/XntxbPyJQzCG+p4EKOpgD3mxFwW38mGjVUrfERQOeY4EDHjdnptttfHuHQXFx+lTP08Q+mLa/w==} @@ -7577,8 +7577,8 @@ snapshots: '@gerrit0/mini-shiki@1.24.2': dependencies: - '@shikijs/engine-oniguruma': 1.24.1 - '@shikijs/types': 1.24.1 + '@shikijs/engine-oniguruma': 1.24.2 + '@shikijs/types': 1.24.2 '@shikijs/vscode-textmate': 9.3.0 '@humanfs/core@0.19.1': {} @@ -8421,12 +8421,12 @@ snapshots: '@rushstack/eslint-patch@1.10.4': {} - '@shikijs/engine-oniguruma@1.24.1': + '@shikijs/engine-oniguruma@1.24.2': dependencies: - '@shikijs/types': 1.24.1 + '@shikijs/types': 1.24.2 '@shikijs/vscode-textmate': 9.3.0 - '@shikijs/types@1.24.1': + '@shikijs/types@1.24.2': dependencies: '@shikijs/vscode-textmate': 9.3.0 '@types/hast': 3.0.4 @@ -8920,7 +8920,7 @@ snapshots: istanbul-lib-report: 3.0.1 istanbul-lib-source-maps: 5.0.6 istanbul-reports: 3.1.7 - magic-string: 0.30.14 + magic-string: 0.30.15 magicast: 0.3.5 std-env: 3.8.0 test-exclude: 7.0.1 @@ -8940,7 +8940,7 @@ snapshots: dependencies: '@vitest/spy': 2.1.8 estree-walker: 3.0.3 - magic-string: 0.30.14 + magic-string: 0.30.15 optionalDependencies: vite: 5.4.11(@types/node@22.10.1)(sass@1.82.0) @@ -8956,7 +8956,7 @@ snapshots: '@vitest/snapshot@2.1.8': dependencies: '@vitest/pretty-format': 2.1.8 - magic-string: 0.30.14 + magic-string: 0.30.15 pathe: 1.1.2 '@vitest/spy@2.1.8': @@ -9268,7 +9268,7 @@ snapshots: dependencies: caniuse-lite: 1.0.30001687 electron-to-chromium: 1.5.72 - node-releases: 2.0.18 + node-releases: 2.0.19 update-browserslist-db: 1.1.1(browserslist@4.24.2) bser@2.1.1: @@ -11750,7 +11750,7 @@ snapshots: lz-string@1.5.0: {} - magic-string@0.30.14: + magic-string@0.30.15: dependencies: '@jridgewell/sourcemap-codec': 1.5.0 @@ -12662,7 +12662,7 @@ snapshots: title-case: 3.0.3 upper-case: 2.0.2 - node-releases@2.0.18: {} + node-releases@2.0.19: {} nopt@7.2.1: dependencies: @@ -14598,7 +14598,7 @@ snapshots: chai: 5.1.2 debug: 4.4.0 expect-type: 1.1.0 - magic-string: 0.30.14 + magic-string: 0.30.15 pathe: 1.1.2 std-env: 3.8.0 tinybench: 2.9.0