refactor: use items instead of data

unjs · Dec 11, 2024 · a2a4ab4 · a2a4ab4
1 parent 8f9e09c
commit a2a4ab4
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/1.guide/1.index.md b/docs/1.guide/1.index.md
@@ -353,7 +353,7 @@ await storage.getItem<string>("k"); // => <string | null>
 
 ```ts
 type StorageDefinition = {
-  data: {
+  items: {
     foo: string;
     baz: number;
   }

diff --git a/src/types.ts b/src/types.ts
@@ -62,11 +62,11 @@ export interface Driver<OptionsT = any, InstanceT = any> {
 }
 
 type StorageDefinition = {
-  data: unknown;
+  items: unknown;
   [key: string]: unknown;
 };
 
-type StorageItemMap<T extends StorageDefinition> = T["data"];
+type StorageItemMap<T extends StorageDefinition> = T["items"];
 
 export interface Storage<T extends StorageValue = StorageValue> {
   // Item

diff --git a/test/storage.test-d.ts b/test/storage.test-d.ts
@@ -9,7 +9,7 @@ describe("types", () => {
       b: boolean;
     };
     type MyStorage = {
-      data: {
+      items: {
         foo: string;
         bar: number;
         baz: TestObjType;