Merge pull request #897 from mtgto/fix_doc_and_type

VerteDinde · web-flow · commit 891321b14491 · 2021-09-15T19:19:26.000-07:00
Fix doc and type
diff --git a/README.md b/README.md
@@ -208,11 +208,11 @@ property which do not require Node integration.
 
 #### client
 
-Spectron uses [WebdriverIO](http://webdriver.io) and exposes the managed
+Spectron uses [WebdriverIO](https://webdriver.io) and exposes the managed
 `client` property on the created `Application` instances.
 
 The `client` API is WebdriverIO's `browser` object. Documentation can be found
-[here](http://webdriver.io/api.html).
+[here](https://webdriver.io/docs/api).
 
 Several additional commands are provided specific to Electron.
 
@@ -221,8 +221,10 @@ All the commands return a `Promise`.
 So if you wanted to get the text of an element you would do:
 
 ```js
-app.client.getText('#error-alert').then(function (errorText) {
-  console.log('The #error-alert text content is ' + errorText)
+app.client.$('#error-alert').then(function (element) {
+  element.getText().then(function (errorText) {
+    console.log('The #error-alert text content is ' + errorText)
+  })
 })
 ```
 
@@ -239,9 +241,8 @@ API in your tests you would do:
 
 ```js
 app.electron.clipboard.writeText('pasta')
-   .electron.clipboard.readText().then(function (clipboardText) {
-     console.log('The clipboard text is ' + clipboardText)
-   })
+const clipboardText = app.electron.clipboard.readText()
+console.log('The clipboard text is ' + clipboardText)
 ```
 
 #### browserWindow
@@ -651,7 +652,7 @@ test.afterEach(t => {
   return t.context.app.stop();
 });
 
-test(t => {
+test('opens a window', t => {
   return t.context.app.client.waitUntilWindowLoaded()
     .getWindowCount().then(count => {
       t.is(count, 1);
@@ -688,7 +689,7 @@ test.afterEach.always(async t => {
   await t.context.app.stop();
 });
 
-test(async t => {
+test('example', async t => {
   const app = t.context.app;
   await app.client.waitUntilWindowLoaded();
 
diff --git a/lib/spectron.d.ts b/lib/spectron.d.ts
@@ -118,15 +118,19 @@ declare module 'spectron' {
     ): Promise<AccessibilityAuditResult>;
   }
 
-  export interface SpectronWindow extends Electron.BrowserWindow {
-    capturePage(): Promise<Electron.NativeImage>;
-  }
+  export type SpectronWindow = {
+    [P in keyof Electron.BrowserWindow]: Electron.BrowserWindow[P] extends (
+      ...args: infer A
+    ) => infer R
+      ? (...args: A) => Promise<R>
+      : undefined;
+  };
 
   export interface SpectronWebContents extends Electron.WebContents {
     savePage(
       fullPath: string,
       saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML',
-      callback?: (eror: Error) => void
+      callback?: (error: Error) => void
     ): boolean;
     savePage(
       fullPath: string,
