From 44a030e223880c9ceac9229780c38e954bcb7c62 Mon Sep 17 00:00:00 2001 From: Saiya Date: Thu, 22 Aug 2024 22:49:52 +0800 Subject: [PATCH] feat: update toc of readmes --- packages/duplex-message/README.md | 5 ++++- packages/simple-electron-ipc/README.md | 5 +++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/duplex-message/README.md b/packages/duplex-message/README.md index d76a403..23f7a0d 100644 --- a/packages/duplex-message/README.md +++ b/packages/duplex-message/README.md @@ -29,7 +29,7 @@ - [Install](#install) - [Example](#example) - [Usage](#usage) - - [import \& debug](#import--debug) + - [Import \& Debug](#import--debug) - [constructor](#constructor) - [Shared instance](#shared-instance) - [on](#on) @@ -40,7 +40,10 @@ - [proxy for PostMessageHub](#proxy-for-postmessagehub) - [dedicated instance for PostMessageHub](#dedicated-instance-for-postmessagehub) - [Error](#error) +- [FAQ](#faq) + - [How to deal with the error `no corresponding handler found for method xxx`?](#how-to-deal-with-the-error-no-corresponding-handler-found-for-method-xxx) - [Development](#development) +- [License](#license) ## Features diff --git a/packages/simple-electron-ipc/README.md b/packages/simple-electron-ipc/README.md index e4f1675..c078106 100644 --- a/packages/simple-electron-ipc/README.md +++ b/packages/simple-electron-ipc/README.md @@ -22,11 +22,12 @@ - [Install](#install) - [Example](#example) - [Usage](#usage) - - [MainMessageHub & RendererMessageHub](#mainmessagehub--renderermessagehub) + - [MainMessageHub \& RendererMessageHub](#mainmessagehub--renderermessagehub) - [emit](#emit) - [on](#on) - [progress](#progress) - [off](#off) + - [destroy](#destroy) - [Error](#error) - [Debug](#debug) ## Features @@ -297,7 +298,7 @@ mainMessageHub.off(peer: WebContents | '*', methodName?: string) rendererMessageHub.off(methodName?: string) ``` -#### destroy +### destroy Destroy instance: remove all message handlers and references of objects. Any invoking of destroyed instance's methods will throw an exception