feat: useStorageState setStoreValue catch this error to the developer (…

…#2123) * fix: useStorageState getStoreValue catch this error to the developer * fix: replace throw with onError --------- Co-authored-by: liuyib <1656081615@qq.com>
alibaba · Mar 28, 2023 · d5fd82c · d5fd82c
1 parent e3a7526
commit d5fd82c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 13 deletions.
diff --git a/packages/hooks/src/createUseStorageState/index.ts b/packages/hooks/src/createUseStorageState/index.ts
@@ -15,17 +15,23 @@ export interface Options<T> {
   serializer?: (value: T) => string;
   deserializer?: (value: string) => T;
   defaultValue?: T | IFuncUpdater<T>;
+  onError?: (error: unknown) => void;
 }
 
 export function createUseStorageState(getStorage: () => Storage | undefined) {
-  function useStorageState<T>(key: string, options?: Options<T>) {
+  function useStorageState<T>(key: string, options: Options<T> = {}) {
     let storage: Storage | undefined;
+    const {
+      onError = (e) => {
+        console.error(e);
+      },
+    } = options;
 
     // https://github.com/alibaba/hooks/issues/800
     try {
       storage = getStorage();
     } catch (err) {
-      console.error(err);
+      onError(err);
     }
 
     const serializer = (value: T) => {
@@ -49,7 +55,7 @@ export function createUseStorageState(getStorage: () => Storage | undefined) {
           return deserializer(raw);
         }
       } catch (e) {
-        console.error(e);
+        onError(e);
       }
       if (isFunction(options?.defaultValue)) {
         return options?.defaultValue();

diff --git a/packages/hooks/src/useLocalStorageState/index.en-US.md b/packages/hooks/src/useLocalStorageState/index.en-US.md
@@ -40,11 +40,12 @@ const [state, setState] = useLocalStorageState<T>(
 
 ### Options
 
-| Property     | Description                   | Type                     | Default          |
-| ------------ | ----------------------------- | ------------------------ | ---------------- |
-| defaultValue | Default value                 | `any \| (() => any)`     | -                |
-| serializer   | Custom serialization method   | `(value: any) => string` | `JSON.stringify` |
-| deserializer | Custom deserialization method | `(value: string) => any` | `JSON.parse`     |
+| Property     | Description                   | Type                       | Default                       |
+| ------------ | ----------------------------- | -------------------------- | ----------------------------- |
+| defaultValue | Default value                 | `any \| (() => any)`       | -                             |
+| serializer   | Custom serialization method   | `(value: any) => string`   | `JSON.stringify`              |
+| deserializer | Custom deserialization method | `(value: string) => any`   | `JSON.parse`                  |
+| onError      | On error callback             | `(error: unknown) => void` | `(e) => { console.error(e) }` |
 
 ## Remark
 

diff --git a/packages/hooks/src/useLocalStorageState/index.zh-CN.md b/packages/hooks/src/useLocalStorageState/index.zh-CN.md
@@ -40,11 +40,12 @@ const [state, setState] = useLocalStorageState<T>(
 
 ### Options
 
-| 参数         | 说明               | 类型                     | 默认值           |
-| ------------ | ------------------ | ------------------------ | ---------------- |
-| defaultValue | 默认值             | `any \| (() => any)`     | -                |
-| serializer   | 自定义序列化方法   | `(value: any) => string` | `JSON.stringify` |
-| deserializer | 自定义反序列化方法 | `(value: string) => any` | `JSON.parse`     |
+| 参数         | 说明               | 类型                       | 默认值                        |
+| ------------ | ------------------ | -------------------------- | ----------------------------- |
+| defaultValue | 默认值             | `any \| (() => any)`       | -                             |
+| serializer   | 自定义序列化方法   | `(value: any) => string`   | `JSON.stringify`              |
+| deserializer | 自定义反序列化方法 | `(value: string) => any`   | `JSON.parse`                  |
+| onError      | 错误回调函数       | `(error: unknown) => void` | `(e) => { console.error(e) }` |
 
 ## 备注