fix(types): allow passing generic to untyped storage (#543)

* fix(types): allow passing generic to untyped storage * chore: lint
unjs · Dec 26, 2024 · 605ec41 · 605ec41
1 parent 4a3c7a6
commit 605ec41
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -91,10 +91,10 @@ export interface Storage<T extends StorageValue = StorageValue> {
     key: K,
     ops?: TransactionOptions
   ): Promise<StorageItemType<T, K> | null>;
-  getItem(
+  getItem<R = StorageItemType<T, string>>(
     key: string,
     opts?: TransactionOptions
-  ): Promise<StorageItemType<T, string> | null>;
+  ): Promise<R | null>;
 
   /** @experimental */
   getItems: <U extends T>(

diff --git a/test/storage.test-d.ts b/test/storage.test-d.ts
@@ -10,6 +10,14 @@ describe("types", () => {
       await storage.getItem("foo")
     ).toEqualTypeOf<StorageValue | null>();
 
+    expectTypeOf(await storage.getItem<boolean>("foo")).toEqualTypeOf<
+      boolean | null
+    >();
+
+    expectTypeOf(
+      await storage.getItem<{ hello: string }>("foo")
+    ).toEqualTypeOf<{ hello: string } | null>();
+
     await storage.setItem("foo", "str");
     await storage.set("bar", 1);
     await storage.removeItem("foo");