131 lines
2.9 KiB
TypeScript
131 lines
2.9 KiB
TypeScript
type WindowApi = {
|
|
/**
|
|
* Evaluate a string or function in the web context.
|
|
* @returns Return value of expression given.
|
|
*/
|
|
eval: (
|
|
/** String or function to evaluate. */
|
|
expression: string|Function
|
|
) => Promise<any>
|
|
};
|
|
|
|
type IPCApi = {
|
|
/**
|
|
* Send an IPC event to the web context.
|
|
* @returns Replied event data (null by default).
|
|
*/
|
|
send(
|
|
/** Type of event to send. */
|
|
type: string,
|
|
|
|
/** Data of event to send. */
|
|
data: any
|
|
): Promise<any>,
|
|
|
|
/**
|
|
* Subscribe to IPC events of a specific type with a callback.
|
|
*/
|
|
on(
|
|
/** Type of event to handle. */
|
|
type: string,
|
|
|
|
/**
|
|
* Ran whenever an IPC event of type specified is received. Should return optionally with what to reply with.
|
|
* @returns Optionally with what to reply with, otherwise null by default.
|
|
*/
|
|
callback: (data: any) => any
|
|
): void
|
|
};
|
|
|
|
type CDPApi = {
|
|
/**
|
|
* Send a CDP command to the browser.
|
|
* {@link https://chromedevtools.github.io/devtools-protocol/ Chrome DevTools Protocol Documentation}
|
|
* @returns Result of command from browser.
|
|
*/
|
|
send(
|
|
/** Method of CDP command. */
|
|
method: string,
|
|
|
|
/** Parameters of CDP command. */
|
|
params?: Object,
|
|
|
|
/** Send session ID with the command (default true). */
|
|
useSessionId?: Boolean = true
|
|
): Promise<any>
|
|
};
|
|
|
|
type IdleAutoOptions = {
|
|
/**
|
|
* How long the window should be minimized before hibernating, in seconds.
|
|
* @default 5
|
|
*/
|
|
timeMinimizedToHibernate?: Number
|
|
};
|
|
|
|
type IdleApi = {
|
|
/** Put the window into hibernation. */
|
|
hibernate(): void,
|
|
|
|
/**
|
|
* Put the window to sleep.
|
|
* @todo Unimplemented (for Idle v2).
|
|
*/
|
|
sleep(): void,
|
|
|
|
/** Wake up the window from hibernation or sleep. */
|
|
wake(): void,
|
|
|
|
/** Enable/disable automatic idle management, and set its options. */
|
|
auto(
|
|
/** Whether to use automatic idle management. */
|
|
enabled: Boolean,
|
|
|
|
/** Set options for automatic behavior. */
|
|
options?: IdleAutoOptions
|
|
): void
|
|
};
|
|
|
|
type Window = {
|
|
/** API for accessing the window itself. */
|
|
window: WindowApi,
|
|
|
|
/** API for IPC. */
|
|
ipc: IPCApi,
|
|
|
|
/** API for manually using CDP with the browser. */
|
|
cdp: CDPApi,
|
|
|
|
/**
|
|
* API for Gluon idle management (like hibernation).
|
|
* @experimental
|
|
*/
|
|
idle: IdleApi,
|
|
|
|
/** Close the Gluon window. */
|
|
close(): void
|
|
};
|
|
|
|
|
|
/** A browser that Gluon supports. */
|
|
type Browser = 'chrome'|'chrome_canary'|'chromium'|'edge'|'firefox'|'firefox_nightly';
|
|
|
|
/** Additional options for opening */
|
|
type OpenOptions = {
|
|
/** Function to evaluate in the web context once loaded. */
|
|
onLoad?: Function,
|
|
|
|
/** Force Gluon to use a browser instead of automatically finding. */
|
|
forceBrowser?: Browser,
|
|
};
|
|
|
|
/**
|
|
* Open a new Gluon window.
|
|
*/
|
|
export function open(
|
|
/** URL to load in the window. */
|
|
url: string,
|
|
|
|
/** Additional options for opening. */
|
|
options: OpenOptions
|
|
): Promise<Window>; |