Add data flow to README

instructure · Nov 18, 2024 · 70a6196 · 70a6196
1 parent 9db572d
commit 70a6196
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -105,3 +105,27 @@ export const queryClient = new QueryClient({
   },
 });
 ```
+
+## Data flow
+
+### getItem
+
+```mermaid
+flowchart TD
+    Application([Client app]) --> |".getItem()"| IDBCache[[IDBCache]]
+    IDBCache --> |Get chunks| IndexedDB[(IndexedDB)]
+    IndexedDB -.-> |Encrypted chunks| IDBCache
+    IDBCache -.-> |Encrypted chunks| WebWorker{{Web Worker}}
+    WebWorker -.-> |Decrypted chunks| IDBCache
+    IDBCache --> |"Item"| Application
+```
+
+### setItem
+
+```mermaid
+flowchart TD
+    Application([Client app]) --> |".setItem()"| IDBCache[[IDBCache]]
+    IDBCache -.-> |"Unencrypted chunks"| WebWorker{{Web Worker}}
+    WebWorker -.-> |"Encrypted chunks"| IDBCache
+    IDBCache -.-> |"Encrypted chunks"| IndexedDB[(IndexedDB)]
+```