fix: v1.2.1

eliot-ye · Jan 8, 2024 · e9e5bf5 · e9e5bf5
1 parent d609bd0
commit e9e5bf5
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -89,10 +89,12 @@ const LS = createAsyncStorage(
 
 ```ts
 interface StorageEngine {
-  setItem: (key: string, value: string) => Promise<void> | void;
+  /** 配置是否支持对象存储，如果为 true 则 setItem 的 value 值可能是 JSON，否则为字符串存储 */
+  supportObject?: boolean;
+  setItem: (key: string, value: any) => Promise<void> | void;
   getItem: (
     key: string
-  ) => Promise<string | null | undefined> | string | null | undefined;
+  ) => Promise<any | null | undefined> | any | null | undefined;
   removeItem: (key: string) => Promise<void> | void;
   onReady?: () => Promise<void>;
 }
@@ -103,7 +105,7 @@ interface StorageEngine {
 ```ts
 import type { StorageEngine } from "gpl-async-storage";
 
-export function ELocalStorage(name = "LS"): StorageEngine | null {
+export function ELocalStorage(name = "LS") {
   let ready = false;
   try {
     const testString = "test";
@@ -113,24 +115,26 @@ export function ELocalStorage(name = "LS"): StorageEngine | null {
       ready = true;
     }
   } catch (error) {
-    console.error("ELocalStorage", "unready", error);
+    CusLog.error("ELocalStorage", "unready", error);
   }
 
   if (!ready) {
     return null;
   }
 
-  return {
-    async getItem(key: string) {
+  const storageEngine: StorageEngine = {
+    async getItem(key) {
       return localStorage.getItem(`${name}_${key}`);
     },
-    async setItem(key: string, value: string) {
+    async setItem(key, value) {
       return localStorage.setItem(`${name}_${key}`, value);
     },
-    async removeItem(key: string) {
+    async removeItem(key) {
       return localStorage.removeItem(`${name}_${key}`);
     },
   };
+
+  return storageEngine;
 }
 ```
 

diff --git a/libs/asyncStorage.ts b/libs/asyncStorage.ts
@@ -5,17 +5,13 @@ interface SubscribeFn {
   (): void;
 }
 
-export interface StorageEngine<SO extends boolean> {
-  supportObject: SO;
-  setItem: (
-    key: string,
-    value: SO extends true ? Object : string
-  ) => Promise<void> | void;
+export interface StorageEngine {
+  /** 配置是否支持对象存储，如果为 true 则 setItem 的 value 值可能是 JSON，否则为字符串存储 */
+  supportObject?: boolean;
+  setItem: (key: string, value: any) => Promise<void> | void;
   getItem: (
     key: string
-  ) => SO extends true
-    ? Object
-    : Promise<string | null | undefined> | string | null | undefined;
+  ) => Promise<any | null | undefined> | any | null | undefined;
   removeItem: (key: string) => Promise<void> | void;
   onReady?: () => Promise<void>;
 }
@@ -35,11 +31,7 @@ export enum ErrorMessage {
 
 export function createAsyncStorage<T extends JSONConstraint>(
   initialData: T,
-  engines: (
-    | StorageEngine<boolean>
-    | (() => StorageEngine<boolean> | null)
-    | null
-  )[],
+  engines: (StorageEngine | (() => StorageEngine | null) | null)[],
   option: Option<T> = {}
 ) {
   type Key = keyof T;

diff --git a/libs/engine/cookie.ts b/libs/engine/cookie.ts
@@ -17,7 +17,7 @@ export function ECookie(name = "LS") {
     return null;
   }
 
-  const storageEngine: StorageEngine<false> = {
+  const storageEngine: StorageEngine = {
     supportObject: false,
     getItem(key) {
       return (

diff --git a/libs/engine/indexedDB.ts b/libs/engine/indexedDB.ts
@@ -37,7 +37,7 @@ export function EIndexedDB(name = "asyncStorage", version = 1) {
     return null;
   }
 
-  const storageEngine: StorageEngine<true> = {
+  const storageEngine: StorageEngine = {
     supportObject: true,
     onReady() {
       return new Promise((resolve) => {

diff --git a/libs/engine/localStorage.ts b/libs/engine/localStorage.ts
@@ -18,8 +18,7 @@ export function ELocalStorage(name = "LS") {
     return null;
   }
 
-  const storageEngine: StorageEngine<false> = {
-    supportObject: false,
+  const storageEngine: StorageEngine = {
     async getItem(key) {
       return localStorage.getItem(`${name}_${key}`);
     },

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gpl-async-storage",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "一个异步 API 的本地存储库",
   "license": "MulanPSL-2.0",
   "author": {

diff --git a/src/main.ts b/src/main.ts
@@ -10,7 +10,7 @@ const LS = createAsyncStorage(
     b: "b",
     testObject: { a: 1, b: 2 },
   },
-  [EIndexedDB()]
+  [EIndexedDB(), localStorage]
 );
 
 document.querySelector<HTMLDivElement>("#app")!.innerHTML = `