hyperstorage-js 5.1.0 → 6.0.1

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import superjson from 'superjson';
 /**
  * @class HyperStorage
  * @classdesc A lightweight wrapper for localStorage/sessionStorage
@@ -9,6 +10,7 @@ declare class HyperStorage<T> {
     #private;
     /** Version of the library, injected via Rollup replace plugin. */
     static readonly version: string;
+    static readonly superjson: typeof superjson;
     /** Key name under which the data is stored. */
     readonly itemName: string;
     /** Default value used when the key does not exist in storage. */
@@ -25,7 +27,7 @@ declare class HyperStorage<T> {
      * @param {string} itemName - The key name under which the data will be stored.
      * @param {T} [defaultValue] - Default value assigned to the key if it does not exist yet.
      * @param {Object} [options={}] - Optional configuration parameters.
-     * @param {(value: string) => string} [options.encodeFn] - Optional function to encode stored values.
+     * @param {(value: T) => string} [options.encodeFn] - Optional function to encode stored values.
      * @param {(value: string) => string} [options.decodeFn] - Optional function to decode stored values.
      * @param {Storage} [options.storage=window.localStorage] - Optional custom storage backend.
      *
@@ -34,8 +36,8 @@ declare class HyperStorage<T> {
      * @throws {TypeError} If `storage` does not implement the standard Storage API.
      */
     constructor(itemName: string, defaultValue: T, options?: {
-        encodeFn?: (value: string) => string;
-        decodeFn?: (value: string) => string;
+        encodeFn?: (value: T) => string;
+        decodeFn?: (value: string) => T;
         storage?: Storage;
     });
     /**
@@ -48,8 +50,9 @@ declare class HyperStorage<T> {
      */
     get value(): T;
     /**
-     * Allows using the setter with a callback.
+     * Allows using the setter with property assignment or a callback.
      */
+    set<K extends keyof T>(key: K, value: T[K]): T;
     set(callback: (value: T) => T): T;
     /**
      * Synchronizes the internal cache (`#value`) with the actual value in storage.
@@ -57,7 +60,7 @@ declare class HyperStorage<T> {
      * This is only necessary if the stored value may have been modified externally.
      * Using this function should be avoided when possible and is not type safe.
      */
-    sync(decodeFn?: (value: string) => string): unknown;
+    sync(decodeFn?: (value: string) => T): unknown;
     /**
      * Resets the stored value to its configured default.
      *