mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
66 lines
3.0 KiB
TypeScript
66 lines
3.0 KiB
TypeScript
/**
|
|
* Copyright (c) 2021 OpenLens Authors
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
import { ipcRenderer } from "electron";
|
|
import { IpcPrefix, IpcRegistrar } from "./ipc-registrar";
|
|
import { Disposers } from "../lens-extension";
|
|
import type { LensRendererExtension } from "../lens-renderer-extension";
|
|
import type { Disposer } from "../../common/utils";
|
|
import { once } from "lodash";
|
|
|
|
export abstract class IpcRenderer extends IpcRegistrar {
|
|
constructor(extension: LensRendererExtension) {
|
|
super(extension);
|
|
extension[Disposers].push(() => IpcRenderer.resetInstance());
|
|
}
|
|
|
|
/**
|
|
* Listen for broadcasts within your extension.
|
|
* If the lifetime of the listener should be tied to the mounted lifetime of
|
|
* a component then putting the returned value in a `disposeOnUnmount` call will suffice.
|
|
* @param channel The channel to listen for broadcasts on
|
|
* @param listener The function that will be called with the arguments of the broadcast
|
|
* @returns An optional disposer, Lens will cleanup even if this is not called
|
|
*/
|
|
listen(channel: string, listener: (event: Electron.IpcRendererEvent, ...args: any[]) => any): Disposer {
|
|
const prefixedChannel = `extensions@${this[IpcPrefix]}:${channel}`;
|
|
const cleanup = once(() => ipcRenderer.removeListener(prefixedChannel, listener));
|
|
|
|
ipcRenderer.addListener(prefixedChannel, listener);
|
|
this.extension[Disposers].push(cleanup);
|
|
|
|
return cleanup;
|
|
}
|
|
|
|
/**
|
|
* Request main to execute its function over the `channel` channel.
|
|
* This function only interacts with functions registered via `Ipc.IpcMain.handleRpc`
|
|
* An error will be thrown if no function has been registered on `main` with this channel ID.
|
|
* @param channel The channel to invoke a RPC on
|
|
* @param args The arguments to pass to the RPC
|
|
* @returns A promise of the resulting value
|
|
*/
|
|
invoke(channel: string, ...args: any[]): Promise<any> {
|
|
const prefixedChannel = `extensions@${this[IpcPrefix]}:${channel}`;
|
|
|
|
return ipcRenderer.invoke(prefixedChannel, ...args);
|
|
}
|
|
}
|