docs(use-local-storage): update the serialization option

SukkaW · Nov 8, 2023 · 61221e2 · 61221e2
1 parent e5ee4dd
commit 61221e2
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/docs/src/pages/use-local-storage.mdx b/docs/src/pages/use-local-storage.mdx
@@ -26,7 +26,18 @@ const Comp = () => {
      *
      * Also, the initial value will also be used during the server-side rendering, see below.
      */
-    'circle'
+    'circle',
+    /**
+     * Optional configuration object enables the customization of value serialization before it's stored in local storage.
+     */
+    {
+      // Optional, default to false. When set to "true", the value will be passed to the localStorage API as is.
+      raw: false,
+      // Optional, default to "JSON.stringify". Can only be specified when the "raw" is set to false (which is the default).
+      serializer: JSON.stringify,
+      // Optional, default to "JSON.parse". Can only be specified when the "raw" is set to false (which is the default).
+      deserializer: JSON.parse,
+    }
   );
 
   return (