How to use the electron-rpc-api.ActionType.Promise function in electron-rpc-api
To help you get started, we’ve selected a few electron-rpc-api examples, based on popular ways it is used in public projects.
Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
vladimiry / ElectronMail / src / shared / api / main.ts View on Github 
toggleBrowserWindow: ActionType.Promise<{ forcedState: boolean } | void>(),
toggleCompactLayout: ActionType.Promise(),
updateOverlayIcon: ActionType.Promise<{
hasLoggedOut: boolean;
unread: number;
trayIconColor?: string;
unreadBgColor?: string;
unreadTextColor?: string;
}>(),
hotkey: ActionType.Promise<{ type: "copy" | "paste" | "selectAll" }>(),
findInPageDisplay: ActionType.Promise<{ visible: boolean; }>(),
findInPage: ActionType.Promise<{ query: string; options?: Electron.FindInPageOptions; },
Pick | null>(),
findInPageStop: ActionType.Promise(),
findInPageNotification: ActionType.Observable(),
selectAccount: ActionType.Promise<{ databaseView?: boolean; reset?: boolean }>(),
updateCheck: ActionType.Promise>(),
toggleControls: ActionType.Promise, "hideControls"> | void, void>(),
toggleLocalDbMailsListViewMode: ActionType.Promise(),export type IpcMainServiceScan = ScanService;
export type IpcMainApiEndpoints = IpcMainServiceScan["ApiClient"];
export const ENDPOINTS_DEFINITION = {
getSpellCheckMetadata: ActionType.Promise }>(),
changeSpellCheckLocale: ActionType.Promise<{ locale: FuzzyLocale }>(),
spellCheck: ActionType.Promise<{ words: string[] }, { misspelledWords: string[] }>(),
addAccount: ActionType.Promise(),
updateAccount: ActionType.Promise(),
changeAccountOrder: ActionType.Promise(),
removeAccount: ActionType.Promise(),
changeMasterPassword: ActionType.Promise(),
dbPatch: ActionType.Promise["metadata"], "type"> },
DbModel.FsDbAccount["metadata"]>(),
dbGetAccountMetadata: ActionType.Promise(),
dbGetAccountDataView: ActionType.PromisetoggleCompactLayout: ActionType.Promise(),
updateOverlayIcon: ActionType.Promise<{
hasLoggedOut: boolean;
unread: number;
trayIconColor?: string;
unreadBgColor?: string;
unreadTextColor?: string;
}>(),
hotkey: ActionType.Promise<{ type: "copy" | "paste" | "selectAll" }>(),
findInPageDisplay: ActionType.Promise<{ visible: boolean; }>(),
findInPage: ActionType.Promise<{ query: string; options?: Electron.FindInPageOptions; },
Pick | null>(),
findInPageStop: ActionType.Promise(),
findInPageNotification: ActionType.Observable(),
selectAccount: ActionType.Promise<{ databaseView?: boolean; reset?: boolean }>(),
updateCheck: ActionType.Promise>(),
toggleControls: ActionType.Promise, "hideControls"> | void, void>(),
toggleLocalDbMailsListViewMode: ActionType.Promise(),
notification: ActionType.Observable>(),
};hotkey: ActionType.Promise<{ type: "copy" | "paste" | "selectAll" }>(),
findInPageDisplay: ActionType.Promise<{ visible: boolean; }>(),
findInPage: ActionType.Promise<{ query: string; options?: Electron.FindInPageOptions; },
Pick | null>(),
findInPageStop: ActionType.Promise(),
findInPageNotification: ActionType.Observable(),
selectAccount: ActionType.Promise<{ databaseView?: boolean; reset?: boolean }>(),
updateCheck: ActionType.Promise>(),
toggleControls: ActionType.Promise, "hideControls"> | void, void>(),
toggleLocalDbMailsListViewMode: ActionType.Promise(),
notification: ActionType.Observable>(),
};
export interface InitResponse {
electronLocations: ElectronContextLocations;
hasSavedPassword?: boolean;
snapPasswordManagerServiceHint?: boolean;
keytarSupport: boolean;
checkUpdateAndNotify: boolean;
}
export const IPC_MAIN_API = createIpcMainApiService({
channel: `${PACKAGE_NAME}:ipcMain-api`,& ({ query: string } | { mailPks: Array }),
DbModel.View.RootConversationNode[]>(),
dbFullTextSearch: ActionType.Promise; },
{
uid: string;
mailsBundleItems: Array<{ mail: DbModel.View.Mail & { score: number; }; conversationSize: number; }>;
} & Pick, "expandedTerms">>(),
dbIndexerOn: ActionType.Promise>(),
dbIndexerNotification: ActionType.Observable>(),
init: ActionType.Promise(),
logout: ActionType.Promise(),
openAboutWindow: ActionType.Promise(),
openExternal: ActionType.Promise<{ url: string }>(),
openSettingsFolder: ActionType.Promise(),
patchBaseConfig: ActionType.Promise(),
quit: ActionType.Promise(),
readConfig: ActionType.Promise(),
readSettings: ActionType.Promise & { savePassword?: boolean; }, Settings>(),
reEncryptSettings: ActionType.Promise(),openExternal: ActionType.Promise<{ url: string }>(),
openSettingsFolder: ActionType.Promise(),
patchBaseConfig: ActionType.Promise(),
quit: ActionType.Promise(),
readConfig: ActionType.Promise(),
readSettings: ActionType.Promise & { savePassword?: boolean; }, Settings>(),
reEncryptSettings: ActionType.Promise(),
settingsExists: ActionType.Promise(),
loadDatabase: ActionType.Promise>(),
activateBrowserWindow: ActionType.Promise(),
toggleBrowserWindow: ActionType.Promise<{ forcedState: boolean } | void>(),
toggleCompactLayout: ActionType.Promise(),
updateOverlayIcon: ActionType.Promise<{
hasLoggedOut: boolean;
unread: number;
trayIconColor?: string;
unreadBgColor?: string;
unreadTextColor?: string;
}>(),{
uid: string;
mailsBundleItems: Array<{ mail: DbModel.View.Mail & { score: number; }; conversationSize: number; }>;
} & Pick, "expandedTerms">>(),
dbIndexerOn: ActionType.Promise>(),
dbIndexerNotification: ActionType.Observable>(),
init: ActionType.Promise(),
logout: ActionType.Promise(),
openAboutWindow: ActionType.Promise(),
openExternal: ActionType.Promise<{ url: string }>(),
openSettingsFolder: ActionType.Promise(),
patchBaseConfig: ActionType.Promise(),
quit: ActionType.Promise(),
readConfig: ActionType.Promise(),
readSettings: ActionType.Promise & { savePassword?: boolean; }, Settings>(),
reEncryptSettings: ActionType.Promise(),
settingsExists: ActionType.Promise(),
loadDatabase: ActionType.Promise>(),logout: ActionType.Promise(),
openAboutWindow: ActionType.Promise(),
openExternal: ActionType.Promise<{ url: string }>(),
openSettingsFolder: ActionType.Promise(),
patchBaseConfig: ActionType.Promise(),
quit: ActionType.Promise(),
readConfig: ActionType.Promise(),
readSettings: ActionType.Promise & { savePassword?: boolean; }, Settings>(),
reEncryptSettings: ActionType.Promise(),
settingsExists: ActionType.Promise(),
loadDatabase: ActionType.Promise>(),
activateBrowserWindow: ActionType.Promise(),
toggleBrowserWindow: ActionType.Promise<{ forcedState: boolean } | void>(),
toggleCompactLayout: ActionType.Promise(),
updateOverlayIcon: ActionType.Promise<{
hasLoggedOut: boolean;
unread: number;changeSpellCheckLocale: ActionType.Promise<{ locale: FuzzyLocale }>(),
spellCheck: ActionType.Promise<{ words: string[] }, { misspelledWords: string[] }>(),
addAccount: ActionType.Promise(),
updateAccount: ActionType.Promise(),
changeAccountOrder: ActionType.Promise(),
removeAccount: ActionType.Promise(),
changeMasterPassword: ActionType.Promise(),
dbPatch: ActionType.Promise["metadata"], "type"> },
DbModel.FsDbAccount["metadata"]>(),
dbGetAccountMetadata: ActionType.Promise(),
dbGetAccountDataView: ActionType.Promise(),
dbGetAccountMail: ActionType.Promise(),openAboutWindow: ActionType.Promise(),
openExternal: ActionType.Promise<{ url: string }>(),
openSettingsFolder: ActionType.Promise(),
patchBaseConfig: ActionType.Promise(),
quit: ActionType.Promise(),
readConfig: ActionType.Promise(),
readSettings: ActionType.Promise & { savePassword?: boolean; }, Settings>(),
reEncryptSettings: ActionType.Promise(),
settingsExists: ActionType.Promise(),
loadDatabase: ActionType.Promise>(),
activateBrowserWindow: ActionType.Promise(),
toggleBrowserWindow: ActionType.Promise<{ forcedState: boolean } | void>(),
toggleCompactLayout: ActionType.Promise(),
updateOverlayIcon: ActionType.Promise<{
hasLoggedOut: boolean;
unread: number;
trayIconColor?: string;
unreadBgColor?: string;electron-rpc-api
Wrapper around the Electron's IPC for building type-safe API based RPC-like and reactive interactions
