hyperstorage-js 6.0.4 → 6.0.6

package/README.md

@@ -1,332 +1,385 @@
-# HyperStorage: Storage Manager for JavaScript/TypeScript
-
-A lightweight wrapper for Storage interfaces (e.g., `localStorage` or `sessionStorage`) with **efficient caching** and **type-preserving serialization**.
-
-The biggest burdens of working with the **Storage API** is verifying values on every read, providing proper default values and only being able to store strings, having to `JSON.stringify()` and `JSON.parse()` manually everytime. This package eliminates this all by providing a safe, automatic and efficient wrapper that handles everything for you. You can read/store numbers and objects without any extra steps, lose no performance and improve code readability.
-
-[![npm version](https://img.shields.io/npm/v/hyperstorage-js.svg)](https://www.npmjs.com/package/hyperstorage-js)
-[![npm downloads](https://img.shields.io/npm/dt/hyperstorage-js.svg)](https://www.npmjs.com/package/hyperstorage-js)
-[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/hyperstorage-js/badge)](https://www.jsdelivr.com/package/npm/hyperstorage-js)
-
-<br>
-
-## Features
-
-- 📝 **Default values**: are automatically set when the key is not in Storage.
-- 🧩 **(Super)JSON support**: automatically serializes and parses everything using [superjson](https://github.com/flightcontrolhq/superjson).
-- 🧠 **TypeScript support**: full type safety with strongly typed keys, values, and callbacks.
-- 🔒 **Optional encoding/decoding**: hooks to obfuscate data or change the serializer.
-- ⚡ **Fast caching**: memory cache avoids repeated JSON convertions.
-- 🛠️ **Utility helpers**: use `.set()` and `.isDefault()` to simplify storage operations.
-- 🌐 **Custom storage**: works with any object implementing the standard Storage API. (`localStorage`, `sessionStorage`, ...)
-
-### Supported Types
-
-| Type      | Supported by Storage API | Supported by HyperStorage (trough superjson) |
-| --------- | ------------------------ | -------------------------------------------- |
-| string    | ✅                       | ✅                                           |
-| number    | ❌                       | ✅                                           |
-| boolean   | ❌                       | ✅                                           |
-| null      | ❌                       | ✅                                           |
-| Array     | ❌                       | ✅                                           |
-| Object    | ❌                       | ✅                                           |
-| undefined | ❌                       | ✅                                           |
-| bigint    | ❌                       | ✅                                           |
-| Date      | ❌                       | ✅                                           |
-| RegExp    | ❌                       | ✅                                           |
-| Set       | ❌                       | ✅                                           |
-| Map       | ❌                       | ✅                                           |
-| Error     | ❌                       | ✅                                           |
-| URL       | ❌                       | ✅                                           |
-
-<br>
-
-## Installation
-
-```bash
-# npm
-npm install hyperstorage-js
-
-# pnpm
-pnpm add hyperstorage-js
-
-# yarn
-yarn add hyperstorage-js
-```
-
-<br>
-
-## Constructor Syntax
-
-```ts
-class HyperStorage<T> {
-  constructor(
-    itemName: string,
-    defaultValue: T,
-    options: {
-      encodeFn?: (value: T) => string
-      decodeFn?: (value: string) => T
-      storage?: Storage
-    } = {}
-  )
-}
-```
-
-<br>
-
-## Usage
-
-```js
-import HyperStorage from 'hyperstorage-js'
-```
-
-```js
-const defaultValue = { theme: 'light', language: 'en' }
-const userStore = new HyperStorage('userSettings', defaultValue)
-
-// If 'userSettings' is not present in the Storage, the defaultValue is set:
-console.log(userStore.value) // { theme: 'light', language: 'en' }
-
-// Change theme to dark
-userStore.value = { theme: 'dark', language: 'en' }
-// or
-userStore.set('theme', 'dark')
-
-console.log(userStore.value) // { theme: 'dark', language: 'en' }
-console.log(userStore.value.theme) // 'dark'
-
-// Present in localStorage
-console.log(userStore.storage) // Storage {userSettings: '{"json":{"theme":"dark","language":"en"}}', length: 1}
-```
-
-### Advanced Ways to Assign a New Value
-
-```js
-// Overwrite entirely
-userStore.value = { theme: 'dark', language: 'en' }
-
-// Change single property using the setter
-userStore.value = { ...userStore.value, theme: 'dark' }
-
-// Change single property using a callback
-userStore.set((v) => (v.theme = 'dark'))
-
-// Change single property using a property setter
-userStore.set('theme', 'dark')
-```
-
-### Using Another Storage API
-
-Use `sessionStorage` to only remember data for the duration of a session.
-
-```js
-const sessionStore = new HyperStorage('sessionData', 'none', {
-  storage: window.sessionStorage,
-})
-
-sessionStore.value = 'temporary'
-console.log(sessionStore.value) // 'temporary'
-console.log(sessionStore.storage) // Storage {sessionData: '{"json":"temporary"}', length: 1}
-```
-
-### Using Encoding and Decoding Functions
-
-If you want to make stored data significantly harder to reverse-engineer, use the `encodeFn` and `decodeFn` options.
-
-Apply Base64 encoding using JavaScript's `btoa` (String to Base64) and `atob` (Base64 to String).
-
-```js
-const sessionStore = new HyperStorage('sessionData', 'none', {
-  encodeFn: (value) => btoa(value),
-  decodeFn: (value) => atob(value),
-})
-
-sessionStore.value = 'temporary'
-console.log(sessionStore.value) // 'temporary'
-console.log(sessionStore.storage) // Storage  {sessionData: 'dGVtcG9yYXJ5', length: 1}
-```
-
-The default values for `encodeFn` and `decodeFn` are:
-
-```ts
-encodeFn = (value) => HyperStorage.superjson.stringify(value)
-decodeFn = (value) => HyperStorage.superjson.parse<T>(value)
-```
-
-### Resetting Values
-
-```js
-sessionStore.reset()
-console.log(sessionStore.defaultValue) // 'none'
-console.log(sessionStore.value) // 'none'
-```
-
-<br>
-
-## TypeScript Usage
-
-### Using Type Parameter `T`
-
-```ts
-interface Settings {
-  theme: 'system' | 'light' | 'dark'
-  language: string
-}
-
-const defaultValue: Settings = { theme: 'system', language: 'en' }
-const userStore = new HyperStorage<Settings>('userSettings', defaultValue)
-
-// Property 'language' is missing in type '{ theme: "dark"; }' but required in type 'Settings'. ts(2741)
-userStore.value = { theme: 'dark' }
-```
-
-### Using `sync()`
-
-Safe usage of `sync()` requires explicit runtime validation before accessing any properties. It quickly becomes clear how type-unsafe `sync()` is and why it should be avoided.
-
-```ts
-// ... continues from the above example
-
-const result = userStore.sync() // (method): unknown
-// Right now, 'result' equals 'userStore.value' exactly
-
-// 'result' is of type 'unknown'. ts(18046)
-console.log(result.theme) // 'dark'
-
-// No error, but unsafe
-console.log(userStore.value.theme) // 'dark'
-
-// Must narrow down to be safe
-if (result && typeof result === 'object' && 'theme' in result) {
-  // No error, safe
-  console.log(result.theme) // 'dark'
-}
-```
-
-<br>
-
-## API
-
-### `constructor<T>(itemName: string, defaultValue: T, options = {})`
-
-- **itemName**: `string` — key under which the data is stored.
-- **defaultValue**: default value to be stored if none exists.
-- **options** _(optional)_:
-  - `encodeFn` — function to encode values before writing to the `Storage`.
-  - `decodeFn` — function to decode values when reading from the `Storage`.
-  - `storage` — a `Storage` instance (e.g., `localStorage` or `sessionStorage`).
-
-### `value`
-
-- **Getter** — returns the cached value (very fast, does not use `JSON.parse`).
-- **Setter** — sets and caches the value, serializing and encoding it into `Storage`.
-
-### `set(keyOrCallback: (keyof T) | ((value: T) => T), value?: T[keyof T]): T`
-
-- If a **callback** is provided, it receives the current value and must return the new value.
-- If a **key and value** are provided, it updates that single property on the stored object.
-- Returns the updated stored value.
-
-### `reset(): T`
-
-- Resets the stored value to `defaultValue`.
-- Updates both `Storage` and internal cache.
-- Returns the restored default value.
-
-### `isDefault(): boolean`
-
-- Checks whether the cached value equals the configured default.
-- Uses reference comparison for objects and strict equality for primitives.
-- Returns `true` if the current value matches the default, otherwise `false`.
-
-```js
-if (userStore.isDefault()) {
-  console.log('value equals the default value.')
-}
-```
-
-### `sync(decodeFn = this.decodeFn): unknown`
-
-If the underlying `Storage` is not modified through the value setter, the internal cache will **not automatically update**. Use `sync()` to synchronize the internal cache with the actual value stored in `Storage`.
-
-- **decodeFn** _(optional)_ — a function to decode values when reading (defaults to `this.decodeFn`).
-- Reads the value from storage.
-- Decodes it using `decodeFn`.
-- Updates the internal cache.
-- Returns the synchronized value.
-
-The return type is `unknown` because data read from `Storage` cannot be type-checked or trusted at compile time because it may have been modified externally.
-
-```js
-// External change to storage (to be avoided)
-localStorage.setItem('userSettings', '{"theme":"dark"}')
-
-// Resynchronize the cache, optionally with a custom decoder
-userStore.sync((value) => JSON.parse(value))
-
-console.log(userStore.value) // { theme: 'dark' }
-console.log(userStore.storage) // Storage {userSettings: '{"json":{"theme":"dark"}}', length: 1}
-```
-
-#### Why `sync()` is unsafe
-
-1. The item in `Storage` is undecodable by the `decodeFn` passed to `sync()`.
-
-```js
-localStorage.setItem('userSettings', 'not an object')
-
-// SyntaxError: Unexpected token 'o', "not an object" is not valid JSON
-const result = userStore.sync((value) => JSON.parse(value))
-// Execution continues because sync() uses a try-catch
-
-console.log(result) // instance of SyntaxError
-
-// Reset to default value
-console.log(userStore.value) // {theme: 'system', language: 'en'}
-```
-
-2. The item in `Storage`, after being decoded, is not of type `T`.
-
-```js
-localStorage.setItem('userSettings', '{"not":"valid"}')
-
-const result = userStore.sync((value) => JSON.parse(value))
-console.log(result) // {not: 'valid'}
-console.log(userStore.value) // {not: 'valid'}
-```
-
-No errors, but `result` and `userStore.value` are both not of type `T`.
-
-This **must** be manually checked and `userStore.reset()` should be called if the check fails.
-
-```js
-// This example is specifically for type 'Settings'
-if (
-  result &&
-  typeof result === 'object' &&
-  'theme' in result &&
-  'language' in result &&
-  (result.theme === 'system' || result.theme === 'light' || result.theme === 'dark') &&
-  typeof result.language === 'string'
-) {
-  // 'result' is of type 'T'
-} else {
-  // 'result' is not of type 'T'
-  userStore.reset()
-  console.log(userStore.value) // {theme: 'system', language: 'en'}
-}
-
-// 'userStore.value' is of type 'T'
-```
-
-<br>
-
-## Source
-
-[GitHub Repository](https://github.com/Khoeckman/HyperStorage)
-
-<br>
-
-## License
-
-MIT
+# HyperStorage: Storage Manager for JavaScript/TypeScript
+
+[![npm version](https://img.shields.io/npm/v/hyperstorage-js.svg)](https://www.npmjs.com/package/hyperstorage-js)
+[![npm downloads](https://img.shields.io/npm/dt/hyperstorage-js.svg)](https://www.npmjs.com/package/hyperstorage-js)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/hyperstorage-js/badge)](https://www.jsdelivr.com/package/npm/hyperstorage-js)
+
+## Description
+
+A lightweight wrapper for Storage interfaces (e.g., `localStorage` or `sessionStorage`) with **efficient caching** and **type-preserving serialization**.
+
+The biggest burdens of working with the **Storage API** is verifying values on every read, providing proper default values and only being able to store strings, having to `JSON.stringify()` and `JSON.parse()` manually everytime. This package eliminates this all by providing a safe, automatic and efficient wrapper that handles everything for you. You can read/store numbers and objects without any extra steps, lose no performance and improve code readability.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Constructor Syntax](#constructor-syntax)
+- [Usage](#usage)
+  - [Putting a New Value in Storage](#putting-a-new-value-in-storage)
+  - [Using Another Storage API](#using-another-storage-api)
+  - [Using Encoding and Decoding Functions](#using-encoding-and-decoding-functions)
+  - [Reset to Default](#reset-to-default)
+- [TypeScript Usage](#typescript-usage)
+  - [Using Type Parameter `T` in `HyperStorage<T>`](#using-type-parameter-t-in-hyperstoraget)
+  - [Using `sync()`](#using-sync)
+- [Supported Types In Storage](#supported-types-in-storage)
+- [Class Reference](#class-reference)
+
+<br>
+
+## Features
+
+- 📝 **Default values**: are automatically set when the key is not in Storage.
+- 🧩 **(Super)JSON support**: automatically serializes and parses everything using [superjson](https://github.com/flightcontrolhq/superjson).
+- 🧠 **TypeScript support**: full type safety with strongly typed keys, values, and callbacks.
+- 🔒 **Optional encoding/decoding**: hooks to obfuscate data or change the serializer.
+- ⚡ **Fast caching**: memory cache avoids repeated JSON convertions.
+- 🛠️ **Utility helpers**: use `.set()` and `.isDefault()` to simplify storage operations.
+- 🌐 **Custom storage**: works with any object implementing the standard Storage API. (`localStorage`, `sessionStorage`, ...)
+
+<br>
+
+## Installation
+
+```bash
+# npm
+npm install hyperstorage-js
+
+# pnpm
+pnpm add hyperstorage-js
+
+# bun
+bun i hyperstorage-js
+```
+
+<br>
+
+## Constructor Syntax
+
+```ts
+class HyperStorage<T> {
+  constructor(
+    itemName: string,
+    defaultValue: T,
+    options: {
+      encodeFn?: (value: T) => string
+      decodeFn?: (value: string) => T
+      storage?: Storage
+    } = {}
+  )
+}
+```
+
+<br>
+
+## Usage
+
+```js
+import HyperStorage from 'hyperstorage-js'
+```
+
+```js
+const defaultValue = { theme: 'light', language: 'en' }
+const settingsStore = new HyperStorage('settings', defaultValue)
+
+// If 'settings' is not present in localStorage, the defaultValue is set
+console.log(settingsStore.value) // { theme: 'light', language: 'en' }
+
+// Change theme to dark (one of multiple ways)
+settingsStore.set('theme', 'dark')
+
+console.log(settingsStore.value) // { theme: 'dark', language: 'en' }
+console.log(window.localStorage) // Storage {userSettings: '{"json":{"theme":"dark","language":"en"}}', length: 1}
+```
+
+### Putting a New Value in Storage
+
+The default method that works for all use cases is the `value` setter.
+
+```js
+store.value = 'anything'
+```
+
+The [`set()` (click)](#setkeyorcallback-keyof-t--value-t--t-value-tkeyof-t-t) method is a handy wrapper for assigning and can be used as shown in the examples below, which are sorted from best to worst practice.
+
+<details>
+<summary><strong>Object: Change Only One Property</strong></summary>
+
+```js
+// Property setter
+settingsStore.set('theme', 'dark')
+
+// Callback setter
+settingsStore.set((v) => (v.theme = 'dark'))
+
+// Spread operator
+settingsStore.value = { ...settingsStore.value, theme: 'dark' }
+```
+
+</details>
+
+<details>
+<summary><strong>Number: Increment</strong></summary>
+
+```js
+// Increment operator
+numberStore.value += 2
+
+// Callback setter
+numberStore.set((v) => (v += 2))
+
+// Assign new value
+numberStore.value = numberStore.value + 2
+```
+
+</details>
+
+### Using Another Storage API
+
+Use `sessionStorage` to only remember data for the duration of a session.
+
+```js
+const sessionStore = new HyperStorage('sessionData', 'none', {
+  storage: window.sessionStorage,
+})
+
+sessionStore.value = 'temporary'
+console.log(sessionStore.value) // 'temporary'
+console.log(sessionStore.storage) // Storage {sessionData: '{"json":"temporary"}', length: 1}
+```
+
+### Using Encoding and Decoding Functions
+
+If you want to make stored data harder to reverse-engineer, use the `encodeFn` and `decodeFn` options.
+
+The default values for `encodeFn` and `decodeFn` are:
+
+```ts
+encodeFn = (value) => HyperStorage.superjson.stringify(value)
+decodeFn = (value) => HyperStorage.superjson.parse(value)
+```
+
+<details>
+<summary><strong>Base64 Example</strong></summary>
+
+Apply Base64 encoding using JavaScript's `btoa` (String to Base64) and `atob` (Base64 to String).
+
+```js
+const sessionStore = new HyperStorage('sessionData', 'none', {
+  encodeFn: (value) => btoa(value),
+  decodeFn: (value) => atob(value),
+})
+
+sessionStore.value = 'temporary'
+console.log(sessionStore.value) // 'temporary'
+console.log(sessionStore.storage) // Storage  {sessionData: 'dGVtcG9yYXJ5', length: 1}
+```
+
+</details>
+
+### Reset to Default
+
+```js
+console.log(sessionStore.value) // 'temporary'
+console.log(sessionStore.defaultValue) // 'none'
+
+sessionStore.reset()
+console.log(sessionStore.value) // 'none'
+```
+
+<br>
+
+## TypeScript Usage
+
+### Using Type Parameter `T` in `HyperStorage<T>`
+
+```ts
+interface Settings {
+  theme: 'system' | 'light' | 'dark'
+  language: string
+}
+
+const defaultValue: Settings = { theme: 'system', language: 'en' }
+const userStore = new HyperStorage<Settings>('userSettings', defaultValue)
+
+// Property 'language' is missing in type '{ theme: "dark"; }' but required in type 'Settings'. ts(2741)
+userStore.value = { theme: 'dark' }
+```
+
+### Using `sync()`
+
+Safe usage of `sync()` requires explicit runtime validation before accessing any properties. It quickly becomes clear how type-unsafe `sync()` is and why it should be avoided.
+
+```ts
+// ... continues from the above example
+
+const result = userStore.sync() // (method): unknown
+// Right now, 'result' equals 'userStore.value' exactly
+
+// 'result' is of type 'unknown'. ts(18046)
+console.log(result.theme) // 'dark'
+
+// No error, but unsafe
+console.log(userStore.value.theme) // 'dark'
+
+// Must narrow down to be safe
+if (result && typeof result === 'object' && 'theme' in result) {
+  // No error, safe
+  console.log(result.theme) // 'dark'
+}
+```
+
+<br>
+
+## Supported Types in Storage
+
+| Type      | Supported by Storage API | Supported by HyperStorage (trough superjson) |
+| --------- | ------------------------ | -------------------------------------------- |
+| string    | ✅                       | ✅                                           |
+| undefined | ❌                       | ✅                                           |
+| null      | ❌                       | ✅                                           |
+| boolean   | ❌                       | ✅                                           |
+| number    | ❌                       | ✅                                           |
+| bigint    | ❌                       | ✅                                           |
+| Object    | ❌                       | ✅                                           |
+| Array     | ❌                       | ✅                                           |
+| Set       | ❌                       | ✅                                           |
+| Map       | ❌                       | ✅                                           |
+| URL       | ❌                       | ✅                                           |
+| Date      | ❌                       | ✅                                           |
+| RegExp    | ❌                       | ✅                                           |
+| Error     | ❌                       | ✅                                           |
+
+<br>
+
+## Class Reference
+
+### `constructor<T>(itemName: string, defaultValue: T, options = {})`
+
+- **itemName**: `string` — key under which the data is stored.
+- **defaultValue**: default value to be stored if none exists.
+- **options** _(optional)_:
+  - `encodeFn` — function to encode values before writing to the `Storage`.
+  - `decodeFn` — function to decode values when reading from the `Storage`.
+  - `storage` — a `Storage` instance (e.g., `localStorage` or `sessionStorage`).
+
+### `value`
+
+- **Getter** — returns the cached value (very fast, does not use `JSON.parse`).
+- **Setter** — sets and caches the value, serializing and encoding it into `Storage`.
+
+### `set(keyOrCallback: (keyof T) | ((value: T) => T), value?: T[keyof T]): T`
+
+- If a **callback** is provided, it receives the current value and must return the new value.
+- If a **key and value** are provided, it updates that single property on the stored object.
+- Returns the updated stored value.
+
+### `reset(): T`
+
+- Resets the stored value to `defaultValue`.
+- Updates both `Storage` and internal cache.
+- Returns the restored default value.
+
+### `isDefault(): boolean`
+
+- Checks whether the cached value equals the configured default.
+- Uses reference comparison for objects and strict equality for primitives.
+- Returns `true` if the current value matches the default, otherwise `false`.
+
+```js
+if (userStore.isDefault()) {
+  console.log('value equals the default value.')
+}
+```
+
+### `sync(decodeFn = this.decodeFn): unknown`
+
+If the underlying `Storage` is not modified through the value setter, the internal cache will **not automatically update**. Use `sync()` to synchronize the internal cache with the actual value stored in `Storage`.
+
+- **decodeFn** _(optional)_ — a function to decode values when reading (defaults to `this.decodeFn`).
+- Reads the value from storage.
+- Decodes it using `decodeFn`.
+- Updates the internal cache.
+- Returns the synchronized value.
+
+The return type is `unknown` because data read from `Storage` cannot be type-checked or trusted at compile time because it may have been modified externally.
+
+```js
+// External change to storage (to be avoided)
+localStorage.setItem('userSettings', '{"theme":"dark"}')
+
+// Resynchronize the cache, optionally with a custom decoder
+userStore.sync((value) => JSON.parse(value))
+
+console.log(userStore.value) // { theme: 'dark' }
+console.log(userStore.storage) // Storage {userSettings: '{"json":{"theme":"dark"}}', length: 1}
+```
+
+<br>
+
+<details>
+<summary><strong> Why <code>sync()</code> is unsafe</strong></summary>
+
+1. The item in `Storage` is undecodable by the `decodeFn` passed to `sync()`.
+
+```js
+localStorage.setItem('userSettings', 'not an object')
+
+// SyntaxError: Unexpected token 'o', "not an object" is not valid JSON
+const result = userStore.sync((value) => JSON.parse(value))
+// Execution continues because sync() uses a try-catch
+
+console.log(result) // instance of SyntaxError
+
+// Reset to default value
+console.log(userStore.value) // {theme: 'system', language: 'en'}
+```
+
+2. The item in `Storage`, after being decoded, is not of type `T`.
+
+```js
+localStorage.setItem('userSettings', '{"not":"valid"}')
+
+const result = userStore.sync((value) => JSON.parse(value))
+console.log(result) // {not: 'valid'}
+console.log(userStore.value) // {not: 'valid'}
+```
+
+No errors, but `result` and `userStore.value` are both not of type `T`.
+
+This **must** be manually checked and `userStore.reset()` should be called if the check fails.
+
+```js
+// This example is specifically for type 'Settings'
+if (
+  result &&
+  typeof result === 'object' &&
+  'theme' in result &&
+  'language' in result &&
+  (result.theme === 'system' || result.theme === 'light' || result.theme === 'dark') &&
+  typeof result.language === 'string'
+) {
+  // 'result' is of type 'T'
+} else {
+  // 'result' is not of type 'T'
+  userStore.reset()
+  console.log(userStore.value) // {theme: 'system', language: 'en'}
+}
+
+// 'userStore.value' is of type 'T'
+```
+
+</details>
+
+<br>
+
+## Source
+
+[GitHub Repository](https://github.com/Khoeckman/HyperStorage)
+
+<br>
+
+## License
+
+MIT

package/dist/index.cjs

@@ -867,7 +867,7 @@ SuperJSON.allowErrorProps;
  */
 class HyperStorage {
     /** Version of the library, injected via Rollup replace plugin. */
-    static version = "6.0.4";
+    static version = "6.0.6";
     static superjson = SuperJSON;
     /** Key name under which the data is stored. */
     itemName;
@@ -941,15 +941,15 @@ class HyperStorage {
      * Using this function should be avoided when possible and is not type safe.
      */
     sync(decodeFn = this.#decodeFn) {
-        let json = this.storage.getItem(this.itemName);
+        const json = this.storage.getItem(this.itemName);
         // Reset value to defaultValue if it does not exist in storage
-        if (typeof json !== 'string')
+        if (json === null)
             return this.reset();
-        // Reset value to defaultValue if the incoming value is not properly encoded
         try {
             return (this.value = decodeFn(json));
         }
         catch (err) {
+            // Reset value to defaultValue if the incoming value is not properly encoded
             console.error(err);
             this.reset();
             return err;

package/dist/index.mjs

@@ -865,7 +865,7 @@ SuperJSON.allowErrorProps;
  */
 class HyperStorage {
     /** Version of the library, injected via Rollup replace plugin. */
-    static version = "6.0.4";
+    static version = "6.0.6";
     static superjson = SuperJSON;
     /** Key name under which the data is stored. */
     itemName;
@@ -939,15 +939,15 @@ class HyperStorage {
      * Using this function should be avoided when possible and is not type safe.
      */
     sync(decodeFn = this.#decodeFn) {
-        let json = this.storage.getItem(this.itemName);
+        const json = this.storage.getItem(this.itemName);
         // Reset value to defaultValue if it does not exist in storage
-        if (typeof json !== 'string')
+        if (json === null)
             return this.reset();
-        // Reset value to defaultValue if the incoming value is not properly encoded
         try {
             return (this.value = decodeFn(json));
         }
         catch (err) {
+            // Reset value to defaultValue if the incoming value is not properly encoded
             console.error(err);
             this.reset();
             return err;

package/dist/index.umd.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).HyperStorage=t()}(this,function(){"use strict";class e{constructor(){this.keyToValue=new Map,this.valueToKey=new Map}set(e,t){this.keyToValue.set(e,t),this.valueToKey.set(t,e)}getByKey(e){return this.keyToValue.get(e)}getByValue(e){return this.valueToKey.get(e)}clear(){this.keyToValue.clear(),this.valueToKey.clear()}}class t{constructor(t){this.generateIdentifier=t,this.kv=new e}register(e,t){this.kv.getByValue(e)||(t||(t=this.generateIdentifier(e)),this.kv.set(t,e))}clear(){this.kv.clear()}getIdentifier(e){return this.kv.getByValue(e)}getValue(e){return this.kv.getByKey(e)}}class r extends t{constructor(){super(e=>e.name),this.classToAllowedProps=new Map}register(e,t){"object"==typeof t?(t.allowProps&&this.classToAllowedProps.set(e,t.allowProps),super.register(e,t.identifier)):super.register(e,t)}getAllowedProps(e){return this.classToAllowedProps.get(e)}}function n(e,t){const r=function(e){if("values"in Object)return Object.values(e);const t=[];for(const r in e)e.hasOwnProperty(r)&&t.push(e[r]);return t}(e);if("find"in r)return r.find(t);const n=r;for(let e=0;e<n.length;e++){const r=n[e];if(t(r))return r}}function s(e,t){Object.entries(e).forEach(([e,r])=>t(r,e))}function o(e,t){return-1!==e.indexOf(t)}function i(e,t){for(let r=0;r<e.length;r++){const n=e[r];if(t(n))return n}}class a{constructor(){this.transfomers={}}register(e){this.transfomers[e.name]=e}findApplicable(e){return n(this.transfomers,t=>t.isApplicable(e))}findByName(e){return this.transfomers[e]}}const l=e=>void 0===e,u=e=>"object"==typeof e&&null!==e&&(e!==Object.prototype&&(null===Object.getPrototypeOf(e)||Object.getPrototypeOf(e)===Object.prototype)),c=e=>u(e)&&0===Object.keys(e).length,f=e=>Array.isArray(e),p=e=>e instanceof Map,d=e=>e instanceof Set,y=e=>"Symbol"===(e=>Object.prototype.toString.call(e).slice(8,-1))(e),g=e=>e instanceof Error,m=e=>"number"==typeof e&&isNaN(e),h=e=>(e=>"boolean"==typeof e)(e)||(e=>null===e)(e)||l(e)||(e=>"number"==typeof e&&!isNaN(e))(e)||(e=>"string"==typeof e)(e)||y(e),b=e=>e.replace(/\\/g,"\\\\").replace(/\./g,"\\."),w=e=>e.map(String).map(b).join("."),v=(e,t)=>{const r=[];let n="";for(let s=0;s<e.length;s++){let o=e.charAt(s);if(!t&&"\\"===o){const t=e.charAt(s+1);if("\\"===t){n+="\\",s++;continue}if("."!==t)throw Error("invalid path")}if("\\"===o&&"."===e.charAt(s+1)){n+=".",s++;continue}"."===o?(r.push(n),n=""):n+=o}const s=n;return r.push(s),r};function E(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const I=[E(l,"undefined",()=>null,()=>{}),E(e=>"bigint"==typeof e,"bigint",e=>e.toString(),e=>"undefined"!=typeof BigInt?BigInt(e):(console.error("Please add a BigInt polyfill."),e)),E(e=>e instanceof Date&&!isNaN(e.valueOf()),"Date",e=>e.toISOString(),e=>new Date(e)),E(g,"Error",(e,t)=>{const r={name:e.name,message:e.message};return"cause"in e&&(r.cause=e.cause),t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r},(e,t)=>{const r=new Error(e.message,{cause:e.cause});return r.name=e.name,r.stack=e.stack,t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r}),E(e=>e instanceof RegExp,"regexp",e=>""+e,e=>{const t=e.slice(1,e.lastIndexOf("/")),r=e.slice(e.lastIndexOf("/")+1);return new RegExp(t,r)}),E(d,"set",e=>[...e.values()],e=>new Set(e)),E(p,"map",e=>[...e.entries()],e=>new Map(e)),E(e=>{return m(e)||((t=e)===1/0||t===-1/0);var t},"number",e=>m(e)?"NaN":e>0?"Infinity":"-Infinity",Number),E(e=>0===e&&1/e==-1/0,"number",()=>"-0",Number),E(e=>e instanceof URL,"URL",e=>e.toString(),e=>new URL(e))];function k(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const O=k((e,t)=>{if(y(e)){return!!t.symbolRegistry.getIdentifier(e)}return!1},(e,t)=>["symbol",t.symbolRegistry.getIdentifier(e)],e=>e.description,(e,t,r)=>{const n=r.symbolRegistry.getValue(t[1]);if(!n)throw new Error("Trying to deserialize unknown symbol");return n}),j=[Int8Array,Uint8Array,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array,Uint8ClampedArray].reduce((e,t)=>(e[t.name]=t,e),{}),A=k(e=>ArrayBuffer.isView(e)&&!(e instanceof DataView),e=>["typed-array",e.constructor.name],e=>[...e],(e,t)=>{const r=j[t[1]];if(!r)throw new Error("Trying to deserialize unknown typed array");return new r(e)});function T(e,t){if(e?.constructor){return!!t.classRegistry.getIdentifier(e.constructor)}return!1}const P=k(T,(e,t)=>["class",t.classRegistry.getIdentifier(e.constructor)],(e,t)=>{const r=t.classRegistry.getAllowedProps(e.constructor);if(!r)return{...e};const n={};return r.forEach(t=>{n[t]=e[t]}),n},(e,t,r)=>{const n=r.classRegistry.getValue(t[1]);if(!n)throw new Error(`Trying to deserialize unknown class '${t[1]}' - check https://github.com/blitz-js/superjson/issues/116#issuecomment-773996564`);return Object.assign(Object.create(n.prototype),e)}),V=k((e,t)=>!!t.customTransformerRegistry.findApplicable(e),(e,t)=>["custom",t.customTransformerRegistry.findApplicable(e).name],(e,t)=>t.customTransformerRegistry.findApplicable(e).serialize(e),(e,t,r)=>{const n=r.customTransformerRegistry.findByName(t[1]);if(!n)throw new Error("Trying to deserialize unknown custom value");return n.deserialize(e)}),R=[P,O,V,A],S=(e,t)=>{const r=i(R,r=>r.isApplicable(e,t));if(r)return{value:r.transform(e,t),type:r.annotation(e,t)};const n=i(I,r=>r.isApplicable(e,t));return n?{value:n.transform(e,t),type:n.annotation}:void 0},N={};I.forEach(e=>{N[e.annotation]=e});const z=(e,t)=>{if(t>e.size)throw new Error("index out of bounds");const r=e.keys();for(;t>0;)r.next(),t--;return r.next().value};function _(e){if(o(e,"__proto__"))throw new Error("__proto__ is not allowed as a property");if(o(e,"prototype"))throw new Error("prototype is not allowed as a property");if(o(e,"constructor"))throw new Error("constructor is not allowed as a property")}const x=(e,t,r)=>{if(_(t),0===t.length)return r(e);let n=e;for(let e=0;e<t.length-1;e++){const r=t[e];if(f(n)){n=n[+r]}else if(u(n))n=n[r];else if(d(n)){n=z(n,+r)}else if(p(n)){if(e===t.length-2)break;const s=+r,o=0===+t[++e]?"key":"value",i=z(n,s);switch(o){case"key":n=i;break;case"value":n=n.get(i)}}}const s=t[t.length-1];if(f(n)?n[+s]=r(n[+s]):u(n)&&(n[s]=r(n[s])),d(n)){const e=z(n,+s),t=r(e);e!==t&&(n.delete(e),n.add(t))}if(p(n)){const e=+t[t.length-2],o=z(n,e);switch(0===+s?"key":"value"){case"key":{const e=r(o);n.set(e,n.get(o)),e!==o&&n.delete(o);break}case"value":n.set(o,r(n.get(o)))}}return e},F=e=>e<1;function B(e,t,r,n=[]){if(!e)return;const o=F(r);if(!f(e))return void s(e,(e,s)=>B(e,t,r,[...n,...v(s,o)]));const[i,a]=e;a&&s(a,(e,s)=>{B(e,t,r,[...n,...v(s,o)])}),t(i,n)}function C(e,t,r,n){return B(t,(t,r)=>{e=x(e,r,e=>((e,t,r)=>{if(!f(t)){const n=N[t];if(!n)throw new Error("Unknown transformation: "+t);return n.untransform(e,r)}switch(t[0]){case"symbol":return O.untransform(e,t,r);case"class":return P.untransform(e,t,r);case"custom":return V.untransform(e,t,r);case"typed-array":return A.untransform(e,t,r);default:throw new Error("Unknown transformation: "+t)}})(e,t,n))},r),e}function U(e,t,r){const n=F(r);function o(t,r){const s=((e,t)=>{_(t);for(let r=0;r<t.length;r++){const n=t[r];if(d(e))e=z(e,+n);else if(p(e)){const s=+n,o=0===+t[++r]?"key":"value",i=z(e,s);switch(o){case"key":e=i;break;case"value":e=e.get(i)}}else e=e[n]}return e})(e,v(r,n));t.map(e=>v(e,n)).forEach(t=>{e=x(e,t,()=>s)})}if(f(t)){const[r,i]=t;r.forEach(t=>{e=x(e,v(t,n),()=>e)}),i&&s(i,o)}else s(t,o);return e}const M=(e,t,r,n,i=[],a=[],l=new Map)=>{const y=h(e);if(!y){!function(e,t,r){const n=r.get(e);n?n.push(t):r.set(e,[t])}(e,i,t);const r=l.get(e);if(r)return n?{transformedValue:null}:r}if(!((e,t)=>u(e)||f(e)||p(e)||d(e)||g(e)||T(e,t))(e,r)){const t=S(e,r),n=t?{transformedValue:t.value,annotations:[t.type]}:{transformedValue:e};return y||l.set(e,n),n}if(o(a,e))return{transformedValue:null};const m=S(e,r),w=m?.value??e,v=f(w)?[]:{},E={};s(w,(o,c)=>{if("__proto__"===c||"constructor"===c||"prototype"===c)throw new Error(`Detected property ${c}. This is a prototype pollution risk, please remove it from your object.`);const p=M(o,t,r,n,[...i,c],[...a,e],l);v[c]=p.transformedValue,f(p.annotations)?E[b(c)]=p.annotations:u(p.annotations)&&s(p.annotations,(e,t)=>{E[b(c)+"."+t]=e})});const I=c(E)?{transformedValue:v,annotations:m?[m.type]:void 0}:{transformedValue:v,annotations:m?[m.type,E]:E};return y||l.set(e,I),I};function D(e){return Object.prototype.toString.call(e).slice(8,-1)}function K(e){return"Array"===D(e)}function q(e,t={}){if(K(e))return e.map(e=>q(e,t));if(!function(e){if("Object"!==D(e))return!1;const t=Object.getPrototypeOf(e);return!!t&&t.constructor===Object&&t===Object.prototype}(e))return e;return[...Object.getOwnPropertyNames(e),...Object.getOwnPropertySymbols(e)].reduce((r,n)=>{if("__proto__"===n)return r;if(K(t.props)&&!t.props.includes(n))return r;return function(e,t,r,n,s){const o={}.propertyIsEnumerable.call(n,t)?"enumerable":"nonenumerable";"enumerable"===o&&(e[t]=r),s&&"nonenumerable"===o&&Object.defineProperty(e,t,{value:r,enumerable:!1,writable:!0,configurable:!0})}(r,n,q(e[n],t),e,t.nonenumerable),r},{})}class L{constructor({dedupe:e=!1}={}){this.classRegistry=new r,this.symbolRegistry=new t(e=>e.description??""),this.customTransformerRegistry=new a,this.allowedErrorProps=[],this.dedupe=e}serialize(e){const t=new Map,r=M(e,t,this,this.dedupe),n={json:r.transformedValue};r.annotations&&(n.meta={...n.meta,values:r.annotations});const s=function(e,t){const r={};let n;return e.forEach(e=>{if(e.length<=1)return;t||(e=e.map(e=>e.map(String)).sort((e,t)=>e.length-t.length));const[s,...o]=e;0===s.length?n=o.map(w):r[w(s)]=o.map(w)}),n?c(r)?[n]:[n,r]:c(r)?void 0:r}(t,this.dedupe);return s&&(n.meta={...n.meta,referentialEqualities:s}),n.meta&&(n.meta.v=1),n}deserialize(e,t){const{json:r,meta:n}=e;let s=t?.inPlace?r:q(r);return n?.values&&(s=C(s,n.values,n.v??0,this)),n?.referentialEqualities&&(s=U(s,n.referentialEqualities,n.v??0)),s}stringify(e){return JSON.stringify(this.serialize(e))}parse(e){return this.deserialize(JSON.parse(e),{inPlace:!0})}registerClass(e,t){this.classRegistry.register(e,t)}registerSymbol(e,t){this.symbolRegistry.register(e,t)}registerCustom(e,t){this.customTransformerRegistry.register({name:t,...e})}allowErrorProps(...e){this.allowedErrorProps.push(...e)}}L.defaultInstance=new L,L.serialize=L.defaultInstance.serialize.bind(L.defaultInstance),L.deserialize=L.defaultInstance.deserialize.bind(L.defaultInstance),L.stringify=L.defaultInstance.stringify.bind(L.defaultInstance),L.parse=L.defaultInstance.parse.bind(L.defaultInstance),L.registerClass=L.defaultInstance.registerClass.bind(L.defaultInstance),L.registerSymbol=L.defaultInstance.registerSymbol.bind(L.defaultInstance),L.registerCustom=L.defaultInstance.registerCustom.bind(L.defaultInstance),L.allowErrorProps=L.defaultInstance.allowErrorProps.bind(L.defaultInstance),L.serialize,L.deserialize,L.stringify,L.parse,L.registerClass,L.registerCustom,L.registerSymbol,L.allowErrorProps;class J{static version="6.0.4";static superjson=L;itemName;defaultValue;#e;#t;storage;#r;constructor(e,t,r={}){const{encodeFn:n,decodeFn:s,storage:o=window.localStorage}=r;if("string"!=typeof e)throw new TypeError("itemName is not a string");if(this.itemName=e,this.defaultValue=t,n&&"function"!=typeof n)throw new TypeError("encodeFn is defined but is not a function");if(this.#e=n||(e=>J.superjson.stringify(e)),s&&"function"!=typeof s)throw new TypeError("decodeFn is defined but is not a function");if(this.#t=s||(e=>J.superjson.parse(e)),!(o instanceof Storage))throw new TypeError("storage must be an instance of Storage");this.storage=o,this.sync()}set value(e){this.#r=e,this.storage.setItem(this.itemName,this.#e(e))}get value(){return this.#r}set(e,t){return this.value="function"==typeof e?e(this.#r):{...this.#r,[e]:t}}sync(e=this.#t){let t=this.storage.getItem(this.itemName);if("string"!=typeof t)return this.reset();try{return this.value=e(t)}catch(e){return console.error(e),this.reset(),e}}reset(){return this.value=this.defaultValue}isDefault(){return this.#r===this.defaultValue}}return J});
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).HyperStorage=t()}(this,function(){"use strict";class DoubleIndexedKV{constructor(){this.keyToValue=new Map,this.valueToKey=new Map}set(e,t){this.keyToValue.set(e,t),this.valueToKey.set(t,e)}getByKey(e){return this.keyToValue.get(e)}getByValue(e){return this.valueToKey.get(e)}clear(){this.keyToValue.clear(),this.valueToKey.clear()}}class Registry{constructor(e){this.generateIdentifier=e,this.kv=new DoubleIndexedKV}register(e,t){this.kv.getByValue(e)||(t||(t=this.generateIdentifier(e)),this.kv.set(t,e))}clear(){this.kv.clear()}getIdentifier(e){return this.kv.getByValue(e)}getValue(e){return this.kv.getByKey(e)}}class ClassRegistry extends Registry{constructor(){super(e=>e.name),this.classToAllowedProps=new Map}register(e,t){"object"==typeof t?(t.allowProps&&this.classToAllowedProps.set(e,t.allowProps),super.register(e,t.identifier)):super.register(e,t)}getAllowedProps(e){return this.classToAllowedProps.get(e)}}function e(e,t){const r=function(e){if("values"in Object)return Object.values(e);const t=[];for(const r in e)e.hasOwnProperty(r)&&t.push(e[r]);return t}(e);if("find"in r)return r.find(t);const n=r;for(let e=0;e<n.length;e++){const r=n[e];if(t(r))return r}}function t(e,t){Object.entries(e).forEach(([e,r])=>t(r,e))}function r(e,t){return-1!==e.indexOf(t)}function n(e,t){for(let r=0;r<e.length;r++){const n=e[r];if(t(n))return n}}class CustomTransformerRegistry{constructor(){this.transfomers={}}register(e){this.transfomers[e.name]=e}findApplicable(t){return e(this.transfomers,e=>e.isApplicable(t))}findByName(e){return this.transfomers[e]}}const s=e=>void 0===e,o=e=>"object"==typeof e&&null!==e&&(e!==Object.prototype&&(null===Object.getPrototypeOf(e)||Object.getPrototypeOf(e)===Object.prototype)),i=e=>o(e)&&0===Object.keys(e).length,a=e=>Array.isArray(e),u=e=>e instanceof Map,l=e=>e instanceof Set,c=e=>"Symbol"===(e=>Object.prototype.toString.call(e).slice(8,-1))(e),f=e=>e instanceof Error,p=e=>"number"==typeof e&&isNaN(e),d=e=>(e=>"boolean"==typeof e)(e)||(e=>null===e)(e)||s(e)||(e=>"number"==typeof e&&!isNaN(e))(e)||(e=>"string"==typeof e)(e)||c(e),y=e=>e.replace(/\\/g,"\\\\").replace(/\./g,"\\."),g=e=>e.map(String).map(y).join("."),m=(e,t)=>{const r=[];let n="";for(let s=0;s<e.length;s++){let o=e.charAt(s);if(!t&&"\\"===o){const t=e.charAt(s+1);if("\\"===t){n+="\\",s++;continue}if("."!==t)throw Error("invalid path")}if("\\"===o&&"."===e.charAt(s+1)){n+=".",s++;continue}"."===o?(r.push(n),n=""):n+=o}const s=n;return r.push(s),r};function h(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const S=[h(s,"undefined",()=>null,()=>{}),h(e=>"bigint"==typeof e,"bigint",e=>e.toString(),e=>"undefined"!=typeof BigInt?BigInt(e):(console.error("Please add a BigInt polyfill."),e)),h(e=>e instanceof Date&&!isNaN(e.valueOf()),"Date",e=>e.toISOString(),e=>new Date(e)),h(f,"Error",(e,t)=>{const r={name:e.name,message:e.message};return"cause"in e&&(r.cause=e.cause),t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r},(e,t)=>{const r=new Error(e.message,{cause:e.cause});return r.name=e.name,r.stack=e.stack,t.allowedErrorProps.forEach(t=>{r[t]=e[t]}),r}),h(e=>e instanceof RegExp,"regexp",e=>""+e,e=>{const t=e.slice(1,e.lastIndexOf("/")),r=e.slice(e.lastIndexOf("/")+1);return new RegExp(t,r)}),h(l,"set",e=>[...e.values()],e=>new Set(e)),h(u,"map",e=>[...e.entries()],e=>new Map(e)),h(e=>{return p(e)||((t=e)===1/0||t===-1/0);var t},"number",e=>p(e)?"NaN":e>0?"Infinity":"-Infinity",Number),h(e=>0===e&&1/e==-1/0,"number",()=>"-0",Number),h(e=>e instanceof URL,"URL",e=>e.toString(),e=>new URL(e))];function b(e,t,r,n){return{isApplicable:e,annotation:t,transform:r,untransform:n}}const w=b((e,t)=>{if(c(e)){return!!t.symbolRegistry.getIdentifier(e)}return!1},(e,t)=>["symbol",t.symbolRegistry.getIdentifier(e)],e=>e.description,(e,t,r)=>{const n=r.symbolRegistry.getValue(t[1]);if(!n)throw new Error("Trying to deserialize unknown symbol");return n}),O=[Int8Array,Uint8Array,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array,Uint8ClampedArray].reduce((e,t)=>(e[t.name]=t,e),{}),N=b(e=>ArrayBuffer.isView(e)&&!(e instanceof DataView),e=>["typed-array",e.constructor.name],e=>[...e],(e,t)=>{const r=O[t[1]];if(!r)throw new Error("Trying to deserialize unknown typed array");return new r(e)});function v(e,t){if(e?.constructor){return!!t.classRegistry.getIdentifier(e.constructor)}return!1}const E=b(v,(e,t)=>["class",t.classRegistry.getIdentifier(e.constructor)],(e,t)=>{const r=t.classRegistry.getAllowedProps(e.constructor);if(!r)return{...e};const n={};return r.forEach(t=>{n[t]=e[t]}),n},(e,t,r)=>{const n=r.classRegistry.getValue(t[1]);if(!n)throw new Error(`Trying to deserialize unknown class '${t[1]}' - check https://github.com/blitz-js/superjson/issues/116#issuecomment-773996564`);return Object.assign(Object.create(n.prototype),e)}),I=b((e,t)=>!!t.customTransformerRegistry.findApplicable(e),(e,t)=>["custom",t.customTransformerRegistry.findApplicable(e).name],(e,t)=>t.customTransformerRegistry.findApplicable(e).serialize(e),(e,t,r)=>{const n=r.customTransformerRegistry.findByName(t[1]);if(!n)throw new Error("Trying to deserialize unknown custom value");return n.deserialize(e)}),J=[E,w,I,N],k=(e,t)=>{const r=n(J,r=>r.isApplicable(e,t));if(r)return{value:r.transform(e,t),type:r.annotation(e,t)};const s=n(S,r=>r.isApplicable(e,t));return s?{value:s.transform(e,t),type:s.annotation}:void 0},j={};S.forEach(e=>{j[e.annotation]=e});const A=(e,t)=>{if(t>e.size)throw new Error("index out of bounds");const r=e.keys();for(;t>0;)r.next(),t--;return r.next().value};function T(e){if(r(e,"__proto__"))throw new Error("__proto__ is not allowed as a property");if(r(e,"prototype"))throw new Error("prototype is not allowed as a property");if(r(e,"constructor"))throw new Error("constructor is not allowed as a property")}const R=(e,t,r)=>{if(T(t),0===t.length)return r(e);let n=e;for(let e=0;e<t.length-1;e++){const r=t[e];if(a(n)){n=n[+r]}else if(o(n))n=n[r];else if(l(n)){n=A(n,+r)}else if(u(n)){if(e===t.length-2)break;const s=+r,o=0===+t[++e]?"key":"value",i=A(n,s);switch(o){case"key":n=i;break;case"value":n=n.get(i)}}}const s=t[t.length-1];if(a(n)?n[+s]=r(n[+s]):o(n)&&(n[s]=r(n[s])),l(n)){const e=A(n,+s),t=r(e);e!==t&&(n.delete(e),n.add(t))}if(u(n)){const e=+t[t.length-2],o=A(n,e);switch(0===+s?"key":"value"){case"key":{const e=r(o);n.set(e,n.get(o)),e!==o&&n.delete(o);break}case"value":n.set(o,r(n.get(o)))}}return e},V=e=>e<1;function P(e,r,n,s=[]){if(!e)return;const o=V(n);if(!a(e))return void t(e,(e,t)=>P(e,r,n,[...s,...m(t,o)]));const[i,u]=e;u&&t(u,(e,t)=>{P(e,r,n,[...s,...m(t,o)])}),r(i,s)}function z(e,t,r,n){return P(t,(t,r)=>{e=R(e,r,e=>((e,t,r)=>{if(!a(t)){const n=j[t];if(!n)throw new Error("Unknown transformation: "+t);return n.untransform(e,r)}switch(t[0]){case"symbol":return w.untransform(e,t,r);case"class":return E.untransform(e,t,r);case"custom":return I.untransform(e,t,r);case"typed-array":return N.untransform(e,t,r);default:throw new Error("Unknown transformation: "+t)}})(e,t,n))},r),e}function _(e,r,n){const s=V(n);function o(t,r){const n=((e,t)=>{T(t);for(let r=0;r<t.length;r++){const n=t[r];if(l(e))e=A(e,+n);else if(u(e)){const s=+n,o=0===+t[++r]?"key":"value",i=A(e,s);switch(o){case"key":e=i;break;case"value":e=e.get(i)}}else e=e[n]}return e})(e,m(r,s));t.map(e=>m(e,s)).forEach(t=>{e=R(e,t,()=>n)})}if(a(r)){const[n,i]=r;n.forEach(t=>{e=R(e,m(t,s),()=>e)}),i&&t(i,o)}else t(r,o);return e}const x=(e,n,s,c,p=[],g=[],m=new Map)=>{const h=d(e);if(!h){!function(e,t,r){const n=r.get(e);n?n.push(t):r.set(e,[t])}(e,p,n);const t=m.get(e);if(t)return c?{transformedValue:null}:t}if(!((e,t)=>o(e)||a(e)||u(e)||l(e)||f(e)||v(e,t))(e,s)){const t=k(e,s),r=t?{transformedValue:t.value,annotations:[t.type]}:{transformedValue:e};return h||m.set(e,r),r}if(r(g,e))return{transformedValue:null};const S=k(e,s),b=S?.value??e,w=a(b)?[]:{},O={};t(b,(r,i)=>{if("__proto__"===i||"constructor"===i||"prototype"===i)throw new Error(`Detected property ${i}. This is a prototype pollution risk, please remove it from your object.`);const u=x(r,n,s,c,[...p,i],[...g,e],m);w[i]=u.transformedValue,a(u.annotations)?O[y(i)]=u.annotations:o(u.annotations)&&t(u.annotations,(e,t)=>{O[y(i)+"."+t]=e})});const N=i(O)?{transformedValue:w,annotations:S?[S.type]:void 0}:{transformedValue:w,annotations:S?[S.type,O]:O};return h||m.set(e,N),N};function C(e){return Object.prototype.toString.call(e).slice(8,-1)}function F(e){return"Array"===C(e)}function B(e,t={}){if(F(e))return e.map(e=>B(e,t));if(!function(e){if("Object"!==C(e))return!1;const t=Object.getPrototypeOf(e);return!!t&&t.constructor===Object&&t===Object.prototype}(e))return e;return[...Object.getOwnPropertyNames(e),...Object.getOwnPropertySymbols(e)].reduce((r,n)=>{if("__proto__"===n)return r;if(F(t.props)&&!t.props.includes(n))return r;return function(e,t,r,n,s){const o={}.propertyIsEnumerable.call(n,t)?"enumerable":"nonenumerable";"enumerable"===o&&(e[t]=r),s&&"nonenumerable"===o&&Object.defineProperty(e,t,{value:r,enumerable:!1,writable:!0,configurable:!0})}(r,n,B(e[n],t),e,t.nonenumerable),r},{})}class SuperJSON{constructor({dedupe:e=!1}={}){this.classRegistry=new ClassRegistry,this.symbolRegistry=new Registry(e=>e.description??""),this.customTransformerRegistry=new CustomTransformerRegistry,this.allowedErrorProps=[],this.dedupe=e}serialize(e){const t=new Map,r=x(e,t,this,this.dedupe),n={json:r.transformedValue};r.annotations&&(n.meta={...n.meta,values:r.annotations});const s=function(e,t){const r={};let n;return e.forEach(e=>{if(e.length<=1)return;t||(e=e.map(e=>e.map(String)).sort((e,t)=>e.length-t.length));const[s,...o]=e;0===s.length?n=o.map(g):r[g(s)]=o.map(g)}),n?i(r)?[n]:[n,r]:i(r)?void 0:r}(t,this.dedupe);return s&&(n.meta={...n.meta,referentialEqualities:s}),n.meta&&(n.meta.v=1),n}deserialize(e,t){const{json:r,meta:n}=e;let s=t?.inPlace?r:B(r);return n?.values&&(s=z(s,n.values,n.v??0,this)),n?.referentialEqualities&&(s=_(s,n.referentialEqualities,n.v??0)),s}stringify(e){return JSON.stringify(this.serialize(e))}parse(e){return this.deserialize(JSON.parse(e),{inPlace:!0})}registerClass(e,t){this.classRegistry.register(e,t)}registerSymbol(e,t){this.symbolRegistry.register(e,t)}registerCustom(e,t){this.customTransformerRegistry.register({name:t,...e})}allowErrorProps(...e){this.allowedErrorProps.push(...e)}}SuperJSON.defaultInstance=new SuperJSON,SuperJSON.serialize=SuperJSON.defaultInstance.serialize.bind(SuperJSON.defaultInstance),SuperJSON.deserialize=SuperJSON.defaultInstance.deserialize.bind(SuperJSON.defaultInstance),SuperJSON.stringify=SuperJSON.defaultInstance.stringify.bind(SuperJSON.defaultInstance),SuperJSON.parse=SuperJSON.defaultInstance.parse.bind(SuperJSON.defaultInstance),SuperJSON.registerClass=SuperJSON.defaultInstance.registerClass.bind(SuperJSON.defaultInstance),SuperJSON.registerSymbol=SuperJSON.defaultInstance.registerSymbol.bind(SuperJSON.defaultInstance),SuperJSON.registerCustom=SuperJSON.defaultInstance.registerCustom.bind(SuperJSON.defaultInstance),SuperJSON.allowErrorProps=SuperJSON.defaultInstance.allowErrorProps.bind(SuperJSON.defaultInstance),SuperJSON.serialize,SuperJSON.deserialize,SuperJSON.stringify,SuperJSON.parse,SuperJSON.registerClass,SuperJSON.registerCustom,SuperJSON.registerSymbol,SuperJSON.allowErrorProps;class HyperStorage{static version="6.0.6";static superjson=SuperJSON;itemName;defaultValue;#e;#t;storage;#r;constructor(e,t,r={}){const{encodeFn:n,decodeFn:s,storage:o=window.localStorage}=r;if("string"!=typeof e)throw new TypeError("itemName is not a string");if(this.itemName=e,this.defaultValue=t,n&&"function"!=typeof n)throw new TypeError("encodeFn is defined but is not a function");if(this.#e=n||(e=>HyperStorage.superjson.stringify(e)),s&&"function"!=typeof s)throw new TypeError("decodeFn is defined but is not a function");if(this.#t=s||(e=>HyperStorage.superjson.parse(e)),!(o instanceof Storage))throw new TypeError("storage must be an instance of Storage");this.storage=o,this.sync()}set value(e){this.#r=e,this.storage.setItem(this.itemName,this.#e(e))}get value(){return this.#r}set(e,t){return this.value="function"==typeof e?e(this.#r):{...this.#r,[e]:t}}sync(e=this.#t){const t=this.storage.getItem(this.itemName);if(null===t)return this.reset();try{return this.value=e(t)}catch(e){return console.error(e),this.reset(),e}}reset(){return this.value=this.defaultValue}isDefault(){return this.#r===this.defaultValue}}return HyperStorage});

package/package.json

@@ -1,74 +1,74 @@
-{
-  "name": "hyperstorage-js",
-  "version": "6.0.4",
-  "description": "A lightweight wrapper for localStorage/sessionStorage with efficient caching and type-preserving serialization.",
-  "license": "MIT",
-  "author": "Khoeckman",
-  "type": "module",
-  "main": "dist/index.umd.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.umd.js"
-    }
-  },
-  "files": [
-    "src/",
-    "dist/"
-  ],
-  "scripts": {
-    "test": "exit 0",
-    "build": "rollup -c rollup.config.js",
-    "prepack": "npm run build"
-  },
-  "dependencies": {
-    "superjson": "^2.2.6"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^29.0.0",
-    "@rollup/plugin-node-resolve": "^16.0.3",
-    "@rollup/plugin-replace": "^6.0.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^12.3.0",
-    "@types/node": "^24.10.7",
-    "pnpm": "^10.28.0",
-    "prettier": "^3.7.4",
-    "rollup": "^4.55.1",
-    "rollup-plugin-delete": "^3.0.2",
-    "rollup-plugin-prettier": "^4.1.1",
-    "tslib": "^2.8.1",
-    "typescript": "^5.9.3"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "homepage": "https://github.com/Khoeckman/HyperStorage#readme",
-  "bugs": {
-    "url": "https://github.com/Khoeckman/HyperStorage/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Khoeckman/HyperStorage.git"
-  },
-  "keywords": [
-    "localStorage",
-    "sessionStorage",
-    "storage",
-    "utility",
-    "javascript",
-    "js",
-    "typescript",
-    "ts",
-    "ecmascript",
-    "es",
-    "umd",
-    "browser",
-    "client",
-    "module",
-    "commonjs"
-  ]
-}
+{
+  "name": "hyperstorage-js",
+  "version": "6.0.6",
+  "description": "A lightweight wrapper for localStorage/sessionStorage with efficient caching and type-preserving serialization.",
+  "license": "MIT",
+  "author": "Khoeckman",
+  "type": "module",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.umd.js"
+    }
+  },
+  "files": [
+    "src/",
+    "dist/"
+  ],
+  "scripts": {
+    "test": "exit 0",
+    "build": "rollup -c rollup.config.js",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "superjson": "^2.2.6"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "^6.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^25.3.5",
+    "pnpm": "^10.30.3",
+    "prettier": "^3.8.1",
+    "rollup": "^4.59.0",
+    "rollup-plugin-delete": "^3.0.2",
+    "rollup-plugin-prettier": "^4.1.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/Khoeckman/HyperStorage#readme",
+  "bugs": {
+    "url": "https://github.com/Khoeckman/HyperStorage/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Khoeckman/HyperStorage.git"
+  },
+  "keywords": [
+    "localStorage",
+    "sessionStorage",
+    "storage",
+    "utility",
+    "javascript",
+    "js",
+    "typescript",
+    "ts",
+    "ecmascript",
+    "es",
+    "umd",
+    "browser",
+    "client",
+    "module",
+    "commonjs"
+  ]
+}

package/src/index.ts

@@ -68,7 +68,7 @@ class HyperStorage<T> {
     this.#encodeFn = encodeFn || ((v) => HyperStorage.superjson.stringify(v))
 
     if (decodeFn && typeof decodeFn !== 'function') throw new TypeError('decodeFn is defined but is not a function')
-    this.#decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse<T>(v))
+    this.#decodeFn = decodeFn || ((v) => HyperStorage.superjson.parse(v))
 
     if (!(storage instanceof Storage)) throw new TypeError('storage must be an instance of Storage')
     this.storage = storage
@@ -113,15 +113,15 @@ class HyperStorage<T> {
    * Using this function should be avoided when possible and is not type safe.
    */
   sync(decodeFn = this.#decodeFn): unknown {
-    let json = this.storage.getItem(this.itemName)
+    const json = this.storage.getItem(this.itemName)
 
     // Reset value to defaultValue if it does not exist in storage
-    if (typeof json !== 'string') return this.reset()
+    if (json === null) return this.reset()
 
-    // Reset value to defaultValue if the incoming value is not properly encoded
     try {
       return (this.value = decodeFn(json))
     } catch (err) {
+      // Reset value to defaultValue if the incoming value is not properly encoded
       console.error(err)
       this.reset()
       return err