comments

src/mods/storages/local/async.ts

@@ -1,6 +1,19 @@
 import { useRef } from "react"
 import { AsyncStorage, State } from "../storage"
 
+/**
+ * Asynchronous local storage
+ * 
+ * Use for compatibility with SSR
+ * Use for storing large objects
+ * 
+ * Won't display data on first render or hydratation, you can either:
+ * - use SyncLocalStorage
+ * - use useFallback
+ * 
+ * @see SyncLocalStorage
+ * @see useFallback
+ */
 export function useAsyncLocalStorage() {
   const storage = useRef<AsyncLocalStorage>()
 
@@ -10,6 +23,19 @@ export function useAsyncLocalStorage() {
   return storage.current
 }
 
+/**
+ * Asynchronous local storage
+ * 
+ * Use for compatibility with SSR
+ * Use for storing large objects
+ * 
+ * Won't display data on first render or hydratation, you can either:
+ * - use SyncLocalStorage
+ * - use useFallback
+ * 
+ * @see SyncLocalStorage
+ * @see useFallback
+ */
 export class AsyncLocalStorage implements AsyncStorage<State> {
   readonly async = true
 

src/mods/storages/local/sync.ts

@@ -1,6 +1,16 @@
 import { useRef } from "react"
 import { State, SyncStorage } from "../storage"
 
+/**
+ * Synchronous local storage
+ * 
+ * Do NOT use with SSR, it will create hydratation errors
+ * Do NOT use for storing large objects, it will harm performances
+ * 
+ * Will display data on first render
+ * 
+ * @see AsyncLocalStorage
+ */
 export function useSyncLocalStorage() {
   const storage = useRef<SyncLocalStorage>()
 
@@ -10,6 +20,16 @@ export function useSyncLocalStorage() {
   return storage.current
 }
 
+/**
+ * Synchronous local storage
+ * 
+ * Do NOT use with SSR, it will create hydratation errors
+ * Do NOT use for storing large objects, it will harm performances
+ * 
+ * Will display data on first render
+ * 
+ * @see AsyncLocalStorage
+ */
 export class SyncLocalStorage implements SyncStorage<State> {
   readonly async = false