3b74837020
* Event = Base event type (with preventDefault) * IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.) * IpcRendererEvent = Event that ipcRenderer emits (with sender, senderId, etc.) * KeyboardEvent = Event that we emit with keyboard flags (ctrlKey, altKey, etc.) This will dramatically improve peoples TS experience with IPC events
81 lines
2.4 KiB
TypeScript
81 lines
2.4 KiB
TypeScript
/// <reference path="../electron.d.ts" />
|
|
|
|
/**
|
|
* This file augments the Electron TS namespace with the internal APIs
|
|
* that are not documented but are used by Electron internally
|
|
*/
|
|
|
|
declare namespace Electron {
|
|
enum ProcessType {
|
|
browser = 'browser',
|
|
renderer = 'renderer',
|
|
worker = 'worker'
|
|
}
|
|
|
|
interface App {
|
|
setVersion(version: string): void;
|
|
setDesktopName(name: string): void;
|
|
setAppPath(path: string | null): void;
|
|
}
|
|
|
|
interface SerializedError {
|
|
message: string;
|
|
stack?: string,
|
|
name: string,
|
|
from: Electron.ProcessType,
|
|
cause: SerializedError,
|
|
__ELECTRON_SERIALIZED_ERROR__: true
|
|
}
|
|
|
|
interface InjectionBase {
|
|
url: string;
|
|
code: string
|
|
}
|
|
|
|
interface ContentScript {
|
|
js: Array<InjectionBase>;
|
|
css: Array<InjectionBase>;
|
|
runAt: string;
|
|
matches: {
|
|
some: (input: (pattern: string) => boolean | RegExpMatchArray | null) => boolean;
|
|
}
|
|
}
|
|
|
|
interface RendererProcessPreference {
|
|
contentScripts: Array<ContentScript>
|
|
extensionId: string;
|
|
}
|
|
|
|
interface IpcRendererInternal extends Electron.IpcRenderer {
|
|
sendToAll(webContentsId: number, channel: string, ...args: any[]): void
|
|
}
|
|
|
|
const deprecate: ElectronInternal.DeprecationUtil;
|
|
}
|
|
|
|
declare namespace ElectronInternal {
|
|
type DeprecationHandler = (message: string) => void;
|
|
interface DeprecationUtil {
|
|
setHandler(handler: DeprecationHandler): void;
|
|
getHandler(): DeprecationHandler | null;
|
|
warn(oldName: string, newName: string): void;
|
|
log(message: string): void;
|
|
function(fn: Function, newName: string): Function;
|
|
event(emitter: NodeJS.EventEmitter, oldName: string, newName: string): void;
|
|
removeProperty<T, K extends (keyof T & string)>(object: T, propertyName: K): T;
|
|
renameProperty<T, K extends (keyof T & string)>(object: T, oldName: string, newName: K): T;
|
|
|
|
promisify<T extends (...args: any[]) => any>(fn: T): T;
|
|
promisifyMultiArg<T extends (...args: any[]) => any>(fn: T): T;
|
|
}
|
|
|
|
// Internal IPC has _replyInternal and NO reply method
|
|
interface IpcMainInternalEvent extends Omit<Electron.IpcMainEvent, 'reply'> {
|
|
_replyInternal(...args: any[]): void;
|
|
}
|
|
|
|
interface IpcMainInternal extends Electron.EventEmitter {
|
|
on(channel: string, listener: (event: IpcMainInternalEvent, ...args: any[]) => void): this;
|
|
once(channel: string, listener: (event: IpcMainInternalEvent, ...args: any[]) => void): this;
|
|
}
|
|
}
|