@leexi/shared 0.3.5 → 0.3.7

package/dist/eslint/base.eslint.config.mjs

@@ -1,6 +1,5 @@
 import js from "@eslint/js";
-import stylisticJS from "@stylistic/eslint-plugin-js";
-import stylisticTS from "@stylistic/eslint-plugin-ts";
+import stylistic from "@stylistic/eslint-plugin";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 export default [
@@ -19,7 +18,7 @@ export default [
       }
     },
     plugins: {
-      "@stylistic/js": stylisticJS
+      "@stylistic": stylistic
     },
     rules: {
       "arrow-body-style": ["error", "as-needed"],
@@ -35,33 +34,33 @@ export default [
         destructuring: "all"
       }],
       "prefer-template": "error",
-      "@stylistic/js/array-bracket-spacing": ["error", "never"],
-      "@stylistic/js/arrow-parens": ["error", "as-needed"],
-      "@stylistic/js/comma-dangle": ["error", "always-multiline"],
-      "@stylistic/js/comma-spacing": "error",
-      "@stylistic/js/eol-last": ["error", "always"],
-      "@stylistic/js/indent": ["error", 2, {
+      "@stylistic/array-bracket-spacing": ["error", "never"],
+      "@stylistic/arrow-parens": ["error", "as-needed"],
+      "@stylistic/comma-dangle": ["error", "always-multiline"],
+      "@stylistic/comma-spacing": "error",
+      "@stylistic/eol-last": ["error", "always"],
+      "@stylistic/indent": ["error", 2, {
         SwitchCase: 1
       }],
-      "@stylistic/js/key-spacing": "error",
-      "@stylistic/js/keyword-spacing": "error",
-      "@stylistic/js/multiline-ternary": ["error", "never"],
-      "@stylistic/js/no-multi-spaces": "error",
-      "@stylistic/js/no-multiple-empty-lines": ["error", {
+      "@stylistic/key-spacing": "error",
+      "@stylistic/keyword-spacing": "error",
+      "@stylistic/multiline-ternary": ["error", "never"],
+      "@stylistic/no-multi-spaces": "error",
+      "@stylistic/no-multiple-empty-lines": ["error", {
         max: 1
       }],
-      "@stylistic/js/no-trailing-spaces": "error",
-      "@stylistic/js/object-curly-spacing": ["error", "always"],
-      "@stylistic/js/quote-props": ["error", "consistent-as-needed"],
-      "@stylistic/js/quotes": ["error", "single"],
-      "@stylistic/js/semi": ["error", "always"],
-      "@stylistic/js/semi-spacing": "error",
-      "@stylistic/js/space-before-blocks": ["error", "always"],
-      "@stylistic/js/space-before-function-paren": ["error", "always"],
-      "@stylistic/js/space-in-parens": ["error", "never"],
-      "@stylistic/js/space-infix-ops": "error",
-      "@stylistic/js/spaced-comment": "error",
-      "@stylistic/js/template-curly-spacing": ["error", "never"],
+      "@stylistic/no-trailing-spaces": "error",
+      "@stylistic/object-curly-spacing": ["error", "always"],
+      "@stylistic/quote-props": ["error", "consistent-as-needed"],
+      "@stylistic/quotes": ["error", "single"],
+      "@stylistic/semi": ["error", "always"],
+      "@stylistic/semi-spacing": "error",
+      "@stylistic/space-before-blocks": ["error", "always"],
+      "@stylistic/space-before-function-paren": ["error", "always"],
+      "@stylistic/space-in-parens": ["error", "never"],
+      "@stylistic/space-infix-ops": "error",
+      "@stylistic/spaced-comment": "error",
+      "@stylistic/template-curly-spacing": ["error", "never"],
       "@typescript-eslint/no-unused-expressions": "off",
       "@typescript-eslint/no-unused-vars": ["error", {
         argsIgnorePattern: "^_",
@@ -70,41 +69,6 @@ export default [
       }]
     }
   },
-  // typescript
-  {
-    files: ["**/*.ts", "**/*.vue"],
-    plugins: {
-      "@stylistic/ts": stylisticTS
-    },
-    rules: {
-      "@stylistic/js/comma-dangle": "off",
-      "@stylistic/js/comma-spacing": "off",
-      "@stylistic/js/indent": "off",
-      "@stylistic/js/key-spacing": "off",
-      "@stylistic/js/keyword-spacing": "off",
-      "@stylistic/js/object-curly-spacing": "off",
-      "@stylistic/js/quote-props": "off",
-      "@stylistic/js/quotes": "off",
-      "@stylistic/js/semi": "off",
-      "@stylistic/js/space-before-blocks": "off",
-      "@stylistic/js/space-before-function-paren": "off",
-      "@stylistic/js/space-infix-ops": "off",
-      "@stylistic/ts/comma-dangle": ["error", "always-multiline"],
-      "@stylistic/ts/comma-spacing": "error",
-      "@stylistic/ts/indent": ["error", 2, {
-        SwitchCase: 1
-      }],
-      "@stylistic/ts/key-spacing": "error",
-      "@stylistic/ts/keyword-spacing": "error",
-      "@stylistic/ts/object-curly-spacing": ["error", "always"],
-      "@stylistic/ts/quote-props": ["error", "consistent-as-needed"],
-      "@stylistic/ts/quotes": ["error", "single"],
-      "@stylistic/ts/semi": ["error", "always"],
-      "@stylistic/ts/space-before-blocks": ["error", "always"],
-      "@stylistic/ts/space-before-function-paren": ["error", "always"],
-      "@stylistic/ts/space-infix-ops": "error"
-    }
-  },
   // sort-keys
   {
     files: ["**/*.config.{js,ts}", "**/locales/**/*.js"],

package/dist/eslint/vue.eslint.config.d.ts

@@ -7,6 +7,7 @@ declare const _default: ({
             __filename: false;
             AbortController: false;
             AbortSignal: false;
+            AsyncDisposableStack: false;
             atob: false;
             Blob: false;
             BroadcastChannel: false;
@@ -25,6 +26,7 @@ declare const _default: ({
             CryptoKey: false;
             CustomEvent: false;
             DecompressionStream: false;
+            DisposableStack: false;
             DOMException: false;
             Event: false;
             EventTarget: false;
@@ -64,6 +66,7 @@ declare const _default: ({
             setTimeout: false;
             structuredClone: false;
             SubtleCrypto: false;
+            SuppressedError: false;
             TextDecoder: false;
             TextDecoderStream: false;
             TextEncoder: false;
@@ -71,6 +74,7 @@ declare const _default: ({
             TransformStream: false;
             TransformStreamDefaultController: false;
             URL: false;
+            URLPattern: false;
             URLSearchParams: false;
             WebAssembly: false;
             WebSocket: false;
@@ -83,6 +87,7 @@ declare const _default: ({
             addEventListener: false;
             ai: false;
             AI: false;
+            AICreateMonitor: false;
             AITextSession: false;
             alert: false;
             AnalyserNode: false;
@@ -159,6 +164,7 @@ declare const _default: ({
             close: false;
             closed: false;
             CloseWatcher: false;
+            CommandEvent: false;
             Comment: false;
             CompositionEvent: false;
             confirm: false;
@@ -176,6 +182,7 @@ declare const _default: ({
             CredentialsContainer: false;
             CropTarget: false;
             crossOriginIsolated: false;
+            CSPViolationReportBody: false;
             CSS: false;
             CSSAnimation: false;
             CSSConditionRule: false;
@@ -251,6 +258,7 @@ declare const _default: ({
             DeviceMotionEventRotationRate: false;
             DeviceOrientationEvent: false;
             devicePixelRatio: false;
+            DevicePosture: false;
             dispatchEvent: false;
             document: false;
             Document: false;
@@ -305,9 +313,9 @@ declare const _default: ({
             FileSystemFileEntry: false;
             FileSystemFileHandle: false;
             FileSystemHandle: false;
+            FileSystemObserver: false;
             FileSystemWritableFileStream: false;
             find: false;
-            Float16Array: false;
             focus: false;
             FocusEvent: false;
             FontData: false;
@@ -442,6 +450,7 @@ declare const _default: ({
             HTMLProgressElement: false;
             HTMLQuoteElement: false;
             HTMLScriptElement: false;
+            HTMLSelectedContentElement: false;
             HTMLSelectElement: false;
             HTMLSlotElement: false;
             HTMLSourceElement: false;
@@ -500,6 +509,7 @@ declare const _default: ({
             KeyboardEvent: false;
             KeyboardLayoutMap: false;
             KeyframeEffect: false;
+            LanguageDetector: false;
             LargestContentfulPaint: false;
             LaunchParams: false;
             launchQueue: false;
@@ -592,6 +602,7 @@ declare const _default: ({
             NotifyPaintEvent: false;
             NotRestoredReasonDetails: false;
             NotRestoredReasons: false;
+            Observable: false;
             OfflineAudioCompletionEvent: false;
             OfflineAudioContext: false;
             offscreenBuffering: false;
@@ -619,6 +630,7 @@ declare const _default: ({
             onchange: true;
             onclick: true;
             onclose: true;
+            oncommand: true;
             oncontentvisibilityautostatechange: true;
             oncontextlost: true;
             oncontextmenu: true;
@@ -797,6 +809,7 @@ declare const _default: ({
             RelativeOrientationSensor: false;
             RemotePlayback: false;
             removeEventListener: false;
+            ReportBody: false;
             reportError: false;
             ReportingObserver: false;
             requestAnimationFrame: false;
@@ -806,6 +819,7 @@ declare const _default: ({
             ResizeObserverEntry: false;
             ResizeObserverSize: false;
             resizeTo: false;
+            RestrictionTarget: false;
             RTCCertificate: false;
             RTCDataChannel: false;
             RTCDataChannelEvent: false;
@@ -864,6 +878,11 @@ declare const _default: ({
             ShadowRoot: false;
             sharedStorage: false;
             SharedStorage: false;
+            SharedStorageAppendMethod: false;
+            SharedStorageClearMethod: false;
+            SharedStorageDeleteMethod: false;
+            SharedStorageModifierMethod: false;
+            SharedStorageSetMethod: false;
             SharedStorageWorklet: false;
             SharedWorker: false;
             showDirectoryPicker: false;
@@ -894,6 +913,7 @@ declare const _default: ({
             StyleSheet: false;
             StyleSheetList: false;
             SubmitEvent: false;
+            Subscriber: false;
             SVGAElement: false;
             SVGAngle: false;
             SVGAnimatedAngle: false;
@@ -1025,7 +1045,6 @@ declare const _default: ({
             TrustedTypePolicyFactory: false;
             trustedTypes: false;
             UIEvent: false;
-            URLPattern: false;
             USB: false;
             USBAlternateInterface: false;
             USBConfiguration: false;
@@ -1087,6 +1106,7 @@ declare const _default: ({
             WebTransportSendStream: false;
             WGSLLanguageFeatures: false;
             WheelEvent: false;
+            when: false;
             window: false;
             Window: false;
             WindowControlsOverlay: false;
@@ -1148,15 +1168,10 @@ declare const _default: ({
         };
     };
     plugins: {
-        '@stylistic/js': {
-            rules: import("@stylistic/eslint-plugin-js").Rules;
-            configs: {
-                "disable-legacy": import("eslint").Linter.Config;
-                "all": import("eslint").Linter.Config;
-                "all-flat": import("eslint").Linter.Config;
-            };
+        '@stylistic': {
+            rules: import("@stylistic/eslint-plugin").Rules;
+            configs: import("eslint").ESLint.Plugin["configs"] & import("@stylistic/eslint-plugin").Configs;
         };
-        '@stylistic/ts'?: undefined;
     };
     rules: {
         'arrow-body-style': string[];
@@ -1172,117 +1187,42 @@ declare const _default: ({
             destructuring: string;
         })[];
         'prefer-template': string;
-        '@stylistic/js/array-bracket-spacing': string[];
-        '@stylistic/js/arrow-parens': string[];
-        '@stylistic/js/comma-dangle': string[];
-        '@stylistic/js/comma-spacing': string;
-        '@stylistic/js/eol-last': string[];
-        '@stylistic/js/indent': (string | number | {
+        '@stylistic/array-bracket-spacing': string[];
+        '@stylistic/arrow-parens': string[];
+        '@stylistic/comma-dangle': string[];
+        '@stylistic/comma-spacing': string;
+        '@stylistic/eol-last': string[];
+        '@stylistic/indent': (string | number | {
             SwitchCase: number;
         })[];
-        '@stylistic/js/key-spacing': string;
-        '@stylistic/js/keyword-spacing': string;
-        '@stylistic/js/multiline-ternary': string[];
-        '@stylistic/js/no-multi-spaces': string;
-        '@stylistic/js/no-multiple-empty-lines': (string | {
+        '@stylistic/key-spacing': string;
+        '@stylistic/keyword-spacing': string;
+        '@stylistic/multiline-ternary': string[];
+        '@stylistic/no-multi-spaces': string;
+        '@stylistic/no-multiple-empty-lines': (string | {
             max: number;
         })[];
-        '@stylistic/js/no-trailing-spaces': string;
-        '@stylistic/js/object-curly-spacing': string[];
-        '@stylistic/js/quote-props': string[];
-        '@stylistic/js/quotes': string[];
-        '@stylistic/js/semi': string[];
-        '@stylistic/js/semi-spacing': string;
-        '@stylistic/js/space-before-blocks': string[];
-        '@stylistic/js/space-before-function-paren': string[];
-        '@stylistic/js/space-in-parens': string[];
-        '@stylistic/js/space-infix-ops': string;
-        '@stylistic/js/spaced-comment': string;
-        '@stylistic/js/template-curly-spacing': string[];
+        '@stylistic/no-trailing-spaces': string;
+        '@stylistic/object-curly-spacing': string[];
+        '@stylistic/quote-props': string[];
+        '@stylistic/quotes': string[];
+        '@stylistic/semi': string[];
+        '@stylistic/semi-spacing': string;
+        '@stylistic/space-before-blocks': string[];
+        '@stylistic/space-before-function-paren': string[];
+        '@stylistic/space-in-parens': string[];
+        '@stylistic/space-infix-ops': string;
+        '@stylistic/spaced-comment': string;
+        '@stylistic/template-curly-spacing': string[];
         '@typescript-eslint/no-unused-expressions': string;
         '@typescript-eslint/no-unused-vars': (string | {
             argsIgnorePattern: string;
             destructuredArrayIgnorePattern: string;
             ignoreRestSiblings: boolean;
         })[];
-        '@stylistic/ts/comma-dangle'?: undefined;
-        '@stylistic/ts/comma-spacing'?: undefined;
-        '@stylistic/ts/indent'?: undefined;
-        '@stylistic/ts/key-spacing'?: undefined;
-        '@stylistic/ts/keyword-spacing'?: undefined;
-        '@stylistic/ts/object-curly-spacing'?: undefined;
-        '@stylistic/ts/quote-props'?: undefined;
-        '@stylistic/ts/quotes'?: undefined;
-        '@stylistic/ts/semi'?: undefined;
-        '@stylistic/ts/space-before-blocks'?: undefined;
-        '@stylistic/ts/space-before-function-paren'?: undefined;
-        '@stylistic/ts/space-infix-ops'?: undefined;
         'sort-keys'?: undefined;
     };
     files?: undefined;
-} | {
-    files: string[];
-    plugins: {
-        '@stylistic/ts': {
-            rules: import("@stylistic/eslint-plugin-ts").Rules;
-            configs: {
-                "disable-legacy": import("eslint").Linter.Config;
-                "all": import("eslint").Linter.Config;
-                "all-flat": import("eslint").Linter.Config;
-            };
-        };
-        '@stylistic/js'?: undefined;
-    };
-    rules: {
-        '@stylistic/js/comma-dangle': string;
-        '@stylistic/js/comma-spacing': string;
-        '@stylistic/js/indent': string;
-        '@stylistic/js/key-spacing': string;
-        '@stylistic/js/keyword-spacing': string;
-        '@stylistic/js/object-curly-spacing': string;
-        '@stylistic/js/quote-props': string;
-        '@stylistic/js/quotes': string;
-        '@stylistic/js/semi': string;
-        '@stylistic/js/space-before-blocks': string;
-        '@stylistic/js/space-before-function-paren': string;
-        '@stylistic/js/space-infix-ops': string;
-        '@stylistic/ts/comma-dangle': string[];
-        '@stylistic/ts/comma-spacing': string;
-        '@stylistic/ts/indent': (string | number | {
-            SwitchCase: number;
-        })[];
-        '@stylistic/ts/key-spacing': string;
-        '@stylistic/ts/keyword-spacing': string;
-        '@stylistic/ts/object-curly-spacing': string[];
-        '@stylistic/ts/quote-props': string[];
-        '@stylistic/ts/quotes': string[];
-        '@stylistic/ts/semi': string[];
-        '@stylistic/ts/space-before-blocks': string[];
-        '@stylistic/ts/space-before-function-paren': string[];
-        '@stylistic/ts/space-infix-ops': string;
-        'arrow-body-style'?: undefined;
-        eqeqeq?: undefined;
-        'no-console'?: undefined;
-        'no-nested-ternary'?: undefined;
-        'no-unused-vars'?: undefined;
-        'prefer-const'?: undefined;
-        'prefer-template'?: undefined;
-        '@stylistic/js/array-bracket-spacing'?: undefined;
-        '@stylistic/js/arrow-parens'?: undefined;
-        '@stylistic/js/eol-last'?: undefined;
-        '@stylistic/js/multiline-ternary'?: undefined;
-        '@stylistic/js/no-multi-spaces'?: undefined;
-        '@stylistic/js/no-multiple-empty-lines'?: undefined;
-        '@stylistic/js/no-trailing-spaces'?: undefined;
-        '@stylistic/js/semi-spacing'?: undefined;
-        '@stylistic/js/space-in-parens'?: undefined;
-        '@stylistic/js/spaced-comment'?: undefined;
-        '@stylistic/js/template-curly-spacing'?: undefined;
-        '@typescript-eslint/no-unused-expressions'?: undefined;
-        '@typescript-eslint/no-unused-vars'?: undefined;
-        'sort-keys'?: undefined;
-    };
-    languageOptions?: undefined;
 } | {
     files: string[];
     rules: {
@@ -1297,43 +1237,31 @@ declare const _default: ({
         'no-unused-vars'?: undefined;
         'prefer-const'?: undefined;
         'prefer-template'?: undefined;
-        '@stylistic/js/array-bracket-spacing'?: undefined;
-        '@stylistic/js/arrow-parens'?: undefined;
-        '@stylistic/js/comma-dangle'?: undefined;
-        '@stylistic/js/comma-spacing'?: undefined;
-        '@stylistic/js/eol-last'?: undefined;
-        '@stylistic/js/indent'?: undefined;
-        '@stylistic/js/key-spacing'?: undefined;
-        '@stylistic/js/keyword-spacing'?: undefined;
-        '@stylistic/js/multiline-ternary'?: undefined;
-        '@stylistic/js/no-multi-spaces'?: undefined;
-        '@stylistic/js/no-multiple-empty-lines'?: undefined;
-        '@stylistic/js/no-trailing-spaces'?: undefined;
-        '@stylistic/js/object-curly-spacing'?: undefined;
-        '@stylistic/js/quote-props'?: undefined;
-        '@stylistic/js/quotes'?: undefined;
-        '@stylistic/js/semi'?: undefined;
-        '@stylistic/js/semi-spacing'?: undefined;
-        '@stylistic/js/space-before-blocks'?: undefined;
-        '@stylistic/js/space-before-function-paren'?: undefined;
-        '@stylistic/js/space-in-parens'?: undefined;
-        '@stylistic/js/space-infix-ops'?: undefined;
-        '@stylistic/js/spaced-comment'?: undefined;
-        '@stylistic/js/template-curly-spacing'?: undefined;
+        '@stylistic/array-bracket-spacing'?: undefined;
+        '@stylistic/arrow-parens'?: undefined;
+        '@stylistic/comma-dangle'?: undefined;
+        '@stylistic/comma-spacing'?: undefined;
+        '@stylistic/eol-last'?: undefined;
+        '@stylistic/indent'?: undefined;
+        '@stylistic/key-spacing'?: undefined;
+        '@stylistic/keyword-spacing'?: undefined;
+        '@stylistic/multiline-ternary'?: undefined;
+        '@stylistic/no-multi-spaces'?: undefined;
+        '@stylistic/no-multiple-empty-lines'?: undefined;
+        '@stylistic/no-trailing-spaces'?: undefined;
+        '@stylistic/object-curly-spacing'?: undefined;
+        '@stylistic/quote-props'?: undefined;
+        '@stylistic/quotes'?: undefined;
+        '@stylistic/semi'?: undefined;
+        '@stylistic/semi-spacing'?: undefined;
+        '@stylistic/space-before-blocks'?: undefined;
+        '@stylistic/space-before-function-paren'?: undefined;
+        '@stylistic/space-in-parens'?: undefined;
+        '@stylistic/space-infix-ops'?: undefined;
+        '@stylistic/spaced-comment'?: undefined;
+        '@stylistic/template-curly-spacing'?: undefined;
         '@typescript-eslint/no-unused-expressions'?: undefined;
         '@typescript-eslint/no-unused-vars'?: undefined;
-        '@stylistic/ts/comma-dangle'?: undefined;
-        '@stylistic/ts/comma-spacing'?: undefined;
-        '@stylistic/ts/indent'?: undefined;
-        '@stylistic/ts/key-spacing'?: undefined;
-        '@stylistic/ts/keyword-spacing'?: undefined;
-        '@stylistic/ts/object-curly-spacing'?: undefined;
-        '@stylistic/ts/quote-props'?: undefined;
-        '@stylistic/ts/quotes'?: undefined;
-        '@stylistic/ts/semi'?: undefined;
-        '@stylistic/ts/space-before-blocks'?: undefined;
-        '@stylistic/ts/space-before-function-paren'?: undefined;
-        '@stylistic/ts/space-infix-ops'?: undefined;
     };
     languageOptions?: undefined;
     plugins?: undefined;
@@ -1341,16 +1269,12 @@ declare const _default: ({
     files: string[];
     languageOptions: {
         parserOptions: {
-            parser: {
-                meta?: { [K in keyof import("@typescript-eslint/utils/ts-eslint").Parser.ParserMeta]?: import("@typescript-eslint/utils/ts-eslint").Parser.ParserMeta[K] | undefined; };
-                parseForESLint(text: string, options?: unknown): { [k in keyof import("@typescript-eslint/utils/ts-eslint").Parser.ParseResult]: unknown; };
-            };
+            parser: import("@typescript-eslint/utils/ts-eslint").Parser.LooseParserModule;
         };
     };
     rules: {
-        '@stylistic/js/indent': string;
-        '@stylistic/js/object-curly-spacing': string;
-        '@stylistic/ts/indent': string;
+        '@stylistic/indent': string;
+        '@stylistic/object-curly-spacing': string;
         'tailwindcss/no-custom-classname': string;
         'vue/attributes-order': (string | {
             alphabetical: boolean;

package/dist/eslint/vue.eslint.config.mjs

@@ -14,9 +14,8 @@ export default [
       }
     },
     rules: {
-      "@stylistic/js/indent": "off",
-      "@stylistic/js/object-curly-spacing": "off",
-      "@stylistic/ts/indent": "off",
+      "@stylistic/indent": "off",
+      "@stylistic/object-curly-spacing": "off",
       "tailwindcss/no-custom-classname": "error",
       "vue/attributes-order": ["error", {
         alphabetical: true

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "configKey": "leexi",
   "name": "@leexi/shared",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "builder": {
     "@nuxt/module-builder": "1.0.1",
     "unbuild": "3.5.0"

package/dist/runtime/composables/useLocalStorage.d.ts

@@ -1,16 +1,22 @@
 import type { Ref } from 'vue';
 /**
- * Creates a reactive pointer to a specific localStorage value.
- * The value is stored in the localStorage as a JSON stringified data to enable parsing primitives and objects
+ * A composable that provides a reactive reference to a value stored in localStorage.
+ * It handles JSON parsing/stringifying and migration from kebab-case/snake_case keys to camelCase.
  *
- * @param key - a key pointing to a localStorage value
- * @param defaultValue - an optional default value used if the localStorage value is undefined
- * @returns a reactive variable pointing to that localStorage value
+ * @param key The key to use in localStorage. Throws an error if not camelCase.
+ * @param defaultValue An optional default value to use if the key is not found in localStorage.
+ * @returns A reactive reference (`Ref`) containing the value from localStorage or the default value.
  *
  * @example
- * const fooOne = useLocalStorage('foo')
- * const fooTwo = useLocalStorage('foo', 'bar')
- * fooOne.value // => 'bar'
- * localStorage.foo // => '"bar"'
+ * const userSetting = useLocalStorage('userSetting', { theme: 'light' });
+ * console.log(userSetting.value); // Output: { theme: 'light' }
+ * console.log(localStorage.userSetting); // Output: '{"theme":"light"}'
+ *
+ * const sameUserSetting = useLocalStorage('userSetting');
+ * console.log(sameUserSetting.value); // Output: { theme: 'light' }
+ *
+ * userSetting.value = { theme: 'dark', notifications: true };
+ * console.log(sameUserSetting.value); // Output: { theme: 'dark', notifications: true }
+ * console.log(localStorage.userSetting); // Output: '{"theme":"dark","notifications":true}'
  */
 export declare const useLocalStorage: <T>(key: string, defaultValue?: T) => Ref<undefined | T>;

package/dist/runtime/utils/objects/deepDup.d.ts

@@ -1,9 +1,18 @@
 /**
- * Deeply duplicates an object.
+ * Creates a deep duplicate of an object, array, or Set.
+ * It handles nested objects, arrays, and Sets but does not handle functions, Dates, or circular references.
+ *
+ * @param object The object, array, or Set to duplicate.
+ * @returns A deep copy of the input object.
  *
  * @example
- * const object = [{ foo: 'bar' }]
- * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
- * object === dup // => `false`
+ * const originalObject = { a: 1, b: { c: 2, d: [3, 4] }, e: new Set([5, 6]) };
+ * const duplicatedObject = deepDup(originalObject);
+ *
+ * console.log(duplicatedObject); // Output: { a: 1, b: { c: 2, d: [3, 4] }, e: Set { 5, 6 } }
+ * console.log(originalObject === duplicatedObject); // Output: false
+ * console.log(originalObject.b === duplicatedObject.b); // Output: false
+ * console.log(originalObject.b.d === duplicatedObject.b.d); // Output: false
+ * console.log(originalObject.e === duplicatedObject.e); // Output: false
  */
 export declare const deepDup: <T extends object>(object: T) => T;

package/dist/runtime/utils/objects/isSame.d.ts

@@ -1,8 +1,17 @@
 /**
- * Compares whether two objects are identical.
+ * Checks if two objects are the same by comparing their JSON stringified representations.
+ * Note: This method has limitations and may not accurately compare objects with different key orders, non-primitive values like functions or Dates, or circular references.
+ *
+ * @param a The first object to compare.
+ * @param b The second object to compare.
+ * @returns True if the JSON stringified representations of the objects are identical, false otherwise.
  *
  * @example
- * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
- * isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+ * const obj1 = { a: 1, b: 2 };
+ * const obj2 = { a: 1, b: 2 };
+ * const obj3 = { b: 2, a: 1 };
+ *
+ * console.log(isSame(obj1, obj2)); // Output: true
+ * console.log(isSame(obj1, obj3)); // Output: false (due to key order difference in JSON stringification)
  */
 export declare const isSame: (a: object, b: object) => boolean;

package/dist/runtime/utils/records/omit.d.ts

@@ -1,9 +1,14 @@
 /**
- * Returns a copy of a given object excluding a given set of attributes
+ * Creates a new object by omitting the specified keys from the input record.
+ *
+ * @param record The input record from which to omit keys.
+ * @param keys An array of keys to omit.
+ * @returns A new object with the specified keys removed.
  *
  * @example
- * const foo = { a: 1, b: 2, c: 3 }
- * const bar = omit(foo, ['b', 'c'])
- * bar // => { a: 1 }
+ * const myObject = { a: 1, b: 2, c: 3, d: 4 };
+ * const omittedObject = omit(myObject, ['b', 'd']);
+ *
+ * console.log(omittedObject); // Output: { a: 1, c: 3 }
  */
 export declare const omit: <T extends Record<string, unknown>, K extends (keyof T)[]>(record: T, keys: K) => Omit<T, K[number]>;