release(preload): v2.0.0

alex8088 · Jun 4, 2023 · 0714807 · 0714807
1 parent 36683dd
commit 0714807
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/packages/preload/CHANGELOG.md b/packages/preload/CHANGELOG.md
@@ -1,3 +1,25 @@
+### v2.0.0 (_2023-06-04_)
+
+New way to remove a listener
+
+```ts
+const listener = (_, ...args): void => {}
+const ipc = window.electron.ipcRenderer
+
+// Old, remove listener not work
+ipc.on(channel, listener)
+ipc.removeListener(channel, listener)
+
+// New
+const removeListener = ipc.on(channel, listener)
+removeListener()
+```
+
+- refactor: remove IpcRendererEvent type export and use Electron's own type
+- refactor: remove listener
+- refactor: deprecated IpcRenderer removeListener API
+- chore: export IpcRendererListener type
+
 ### v1.0.3 (_2022-12-28_)
 
 #### Bug Fixes

diff --git a/packages/preload/package.json b/packages/preload/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@electron-toolkit/preload",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Toolkit for electron preload scripts.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",