@@ -9,8 +9,8 @@ import { invokeMainEvent, onRendererEvent, sendMainEvent } from './utils';
99/**
1010 * The Gitify Bridge API exposed to the renderer via `contextBridge`.
1111 *
12- * All renderer↔main IPC communication must go through this object .
13- * It is available on `window.gitify` inside the renderer process .
12+ * Provides a safe, sandboxed interface for IPC communication between renderer and main .
13+ * Accessible as `window.gitify` in the renderer.
1414 */
1515export const api = {
1616 /**
@@ -118,7 +118,6 @@ export const api = {
118118 */
119119 twemojiDirectory : ( ) => invokeMainEvent ( EVENTS . TWEMOJI_DIRECTORY ) ,
120120
121- /** Platform detection helpers. */
122121 /** Platform detection helpers. */
123122 platform : {
124123 /** Returns `true` when running on Linux. */
@@ -161,7 +160,7 @@ export const api = {
161160 } ,
162161 } ,
163162
164- /** Electron web frame zoom controls. */
163+ /** Electron `webFrame` zoom controls. */
165164 zoom : {
166165 /**
167166 * Return the current Electron zoom level.
@@ -231,8 +230,10 @@ export const api = {
231230 } ,
232231} ;
233232
234- // Use `contextBridge` APIs to expose Electron APIs to renderer
235- // Context isolation is always enabled in this app
233+ /**
234+ * Use `contextBridge` APIs to expose Electron APIs to renderer.
235+ * Context isolation is always enabled in this app
236+ */
236237try {
237238 contextBridge . exposeInMainWorld ( 'gitify' , api ) ;
238239} catch ( error ) {
0 commit comments