Skip to content

Commit 0d75e08

Browse files
committed
docs(settings): update cache and P2P reset documentation for new API
1 parent ec95463 commit 0d75e08

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

docs/Settings.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ All settings-related functionality in Peersky flows through a unified preload an
5252
| `settings.getAll()` | `settings-get-all` | Retrieve all settings |
5353
| `settings.set(key, value)` | `settings-set` | Update setting → persist → broadcast |
5454
| `settings.reset()` | `settings-reset` | Reset all settings to defaults |
55-
| `settings.clearCache()` | `settings-clear-cache` | Clears browser + P2P cache |
55+
| `settings.clearBrowserCache()` | `settings-clear-cache` | Clears browser cache |
56+
| `settings.resetP2PData()` | `settings-reset-p2p` | Clears P2P caches |
5657
| `settings.uploadWallpaper(data)` | `settings-upload-wallpaper` | Save + set custom wallpaper |
5758
| `getWallpaperUrl()` | `settings-get-wallpaper-url` | Get wallpaper path (async) |
5859
| `getWallpaperUrlSync()` | `settings-get-wallpaper-url-sync` | Preload sync load for zero-flicker |
@@ -97,12 +98,29 @@ Each section is built using simple HTML blocks styled with internal and theme-pr
9798
- `settings.set('searchEngine', 'DuckDuckGo')`
9899
- Allows user to switch search engines between DuckDuckGo, Brave Search, Ecosia, Kagi, Startpage
99100

100-
### Cache Clearing
101+
### Cache & P2P Data
102+
103+
#### Clear Browser Cache
104+
- **API/IPC:** `settings.clearBrowserCache()` → invokes `ipcMain.handle('settings-clear-cache')`
105+
- **Wipes (Chromium session only):**
106+
- Cookies
107+
- LocalStorage / SessionStorage
108+
- IndexedDB
109+
- Service Workers
110+
- Cache Storage
111+
- HTTP cache (`session.clearCache()`)
112+
- **Does NOT touch:** `ipfs/`, `hyper/`, `ensCache.json`, identity files
113+
114+
#### Reset P2P Data
115+
- **API/IPC:** `settings.resetP2P({ resetIdentities?: boolean })``ipcMain.handle('settings-reset-p2p')`
116+
- **Default behavior (`resetIdentities: false`):**
117+
- Clears P2P caches: `ipfs/` (except `libp2p-key`), `hyper/` (except `swarm-keypair.json`)
118+
- Removes `ensCache.json`
119+
-**Preserves identities:** `ipfs/libp2p-key`, `hyper/swarm-keypair.json`
120+
- **Full wipe (`resetIdentities: true`):**
121+
- Deletes **all** P2P data including identity files
122+
- New identities will be generated on next launch
101123

102-
- `settings.clearCache()`
103-
- Wipes:
104-
- Electron session (cookies, storage)
105-
- P2P caches (`ipfs/`, `hyper/`, `ensCache.json`)
106124

107125
## 6. Adding a New Setting (Example: `autoSave`)
108126

0 commit comments

Comments
 (0)