Skip to content

Commit

Permalink
chore: Publish missing methods types (#390)
Browse files Browse the repository at this point in the history
  • Loading branch information
mykola-mokhnach authored Jul 24, 2024
1 parent 9d081d3 commit 4ed8f35
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion lib/remote-debugger.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ class RemoteDebugger extends EventEmitter {
_clientEventListeners;
/** @type {Record<string, any>} */
appDict;
/** @type {string|null|undefined} */
appIdKey;
/** @type {Record<string, any>[]|undefined} */
connectedDrivers;
/** @type {Record<string, any>[]|undefined} */
Expand Down Expand Up @@ -61,6 +63,8 @@ class RemoteDebugger extends EventEmitter {
searchForPage;
/** @type {(timeoutMs?: number) => Promise<boolean>} */
checkPageIsReady;
/** @type {() => void} */
cancelPageLoad;
/** @type {(dict: Record<string, any>) => void} */
updateAppsWithDict;
/** @type {(startPageLoadTimer?: import('@appium/support').timing.Timer) => Promise<void>} */
Expand All @@ -69,8 +73,18 @@ class RemoteDebugger extends EventEmitter {
execute;
/** @type {(command: string, args?: any[], frames?: string[]) => Promise<any>} */
executeAtom;
/** @type {(atom: string, args?: any[], frames?: string[]) => Promise<any>} */
executeAtomAsync;
/** @type {(readyState: string) => boolean} */
isPageLoadingCompleted;
/** @type {(currentUrl?: string, maxTries?: number, ignoreAboutBlankUrl?: boolean) => Promise<import('./mixins/connect').AppPages[]>} */
selectApp;
/** @type {() => Promise<void>} */
connect;
/** @type {(appIdKey: string, pageIdKey: string, skipReadyCheck?: boolean) => Promise<void>} */
selectPage;
/** @type {(url: string) => Promise<void>} */
navToUrl;

// Callbacks
/** @type {(err: Error?, appIdKey: string, pageDict: Record<string, any>) => Promise<void>} */
Expand Down Expand Up @@ -332,7 +346,7 @@ class RemoteDebugger extends EventEmitter {

/**
* Capture a rect of the page or by default the viewport
* @param {{rect: import('@appium/types').Rect?, coordinateSystem: "Viewport"|"Page"}} [opts={rect: null, coordinateSystem: 'Viewport'}]
* @param {{rect?: import('@appium/types').Rect|null, coordinateSystem?: "Viewport"|"Page"}} [opts={rect: null, coordinateSystem: 'Viewport'}]
* if rect is null capture the whole coordinate system else capture the rect in the given coordinateSystem
* @returns {Promise<string>} a base64 encoded string of the screenshot
*/
Expand Down

0 comments on commit 4ed8f35

Please sign in to comment.