hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Fix spelling and grammar in Ipc docs (#2880)

Browse Source 
Signed-off-by: Sebastian Malton <sebastian@malton.name>
This commit is contained in:
Sebastian Malton 2021-05-27 08:12:53 -04:00 committed by GitHub
parent bfcb6c7e36
commit 81a35737fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/extensions/guides/ipc.md
View File

@ -30,7 +30,7 @@ With this sort of communication the caller needs to wait for the result from the
This is accomplished by `await`-ing the returned `Promise<any>`. This is accomplished by `await`-ing the returned `Promise<any>`.
This is a unidirectional form of communication. This is a unidirectional form of communication.
Only `renderer` can initiate this kind of request, and only `main` can and respond to this kind of request. Only `renderer` can initiate this kind of request, and only `main` can receive and respond to this kind of request.
## Registering IPC Handlers and Listeners ## Registering IPC Handlers and Listeners

2
src/extensions/ipc/ipc-renderer.ts
View File

@ -37,7 +37,7 @@ export abstract class IpcRenderer extends IpcRegistrar {
* a component then putting the returned value in a `disposeOnUnmount` call will suffice. * a component then putting the returned value in a `disposeOnUnmount` call will suffice.
* @param channel The channel to listen for broadcasts on * @param channel The channel to listen for broadcasts on
* @param listener The function that will be called with the arguments of the broadcast * @param listener The function that will be called with the arguments of the broadcast
* @returns An optional disopser, Lens will cleanup even if this is not called * @returns An optional disposer, Lens will cleanup even if this is not called
*/ */
listen(channel: string, listener: (event: Electron.IpcRendererEvent, ...args: any[]) => any): Disposer { listen(channel: string, listener: (event: Electron.IpcRendererEvent, ...args: any[]) => any): Disposer {
const prefixedChannel = `extensions@${this[IpcPrefix]}:${channel}`; const prefixedChannel = `extensions@${this[IpcPrefix]}:${channel}`;