type improvements

README.md

@@ -277,6 +277,26 @@ describe('my extension', () => {
 })
 ```
 
+## TypeScript Support
+
+If you use WebdriverIO with TypeScript make sure to add `wdio-vscode-service` to your `types` in your `tsconfig.json`, e.g.:
+
+```json
+{
+    "compilerOptions": {
+        "moduleResolution": "node",
+        "types": [
+            "webdriverio/async",
+            "@wdio/mocha-framework",
+            "expect-webdriverio",
+            // add this service to your types
+            "wdio-devtools-service"
+        ],
+        "target": "es2019"
+    }
+}
+```
+
 ---
 
 For more information on WebdriverIO check out the project [homepage](https://webdriver.io).

src/index.ts

@@ -1,7 +1,14 @@
 import VSCodeServiceLauncher from './launcher'
 import VSCodeWorkerService from './service'
+import type { WDIOVSCodeServiceOptions as WDIOVSCodeServiceOptionsExtension } from './types'
 
 export default VSCodeWorkerService
 export const launcher = VSCodeServiceLauncher
 
 export * from './pageobjects'
+
+declare global {
+    namespace WebdriverIO {
+        interface WDIOVSCodeServiceOptions extends WDIOVSCodeServiceOptionsExtension {}
+    }
+}

src/service.ts

@@ -223,14 +223,21 @@ export default class VSCodeWorkerService implements Services.ServiceInstance {
     }
 }
 
+interface VSCodeCommands {
+    getWorkbench: () => Promise<Workbench>
+    // Todo(Christian): properly type VSCode object here
+    executeWorkbench: <T>(fn: (vscode: any, ...params: any[]) => T) => Promise<T>
+    getVSCodeVersion: () => Promise<string>
+    getVSCodeChannel: () => Promise<string>
+}
+
 declare global {
     namespace WebdriverIO {
-        interface Browser {
-            getWorkbench: () => Promise<Workbench>
-            // Todo(Christian): properly type VSCode object here
-            executeWorkbench: <T>(fn: (vscode: any, ...params: any[]) => T) => Promise<T>
-            getVSCodeVersion: () => Promise<string>
-            getVSCodeChannel: () => Promise<string>
-        }
+        interface Browser extends VSCodeCommands {}
+    }
+
+    namespace WebdriverIOAsync {
+        interface Browser extends VSCodeCommands {}
+        interface MultiRemoteBrowser extends VSCodeCommands { }
     }
 }

src/types.ts

@@ -2,6 +2,15 @@ import type { ChromedriverServiceOptions } from 'wdio-chromedriver-service'
 import type { Capabilities } from '@wdio/types'
 import type { VSCODE_CAPABILITY_KEY } from './constants'
 
+/**
+ * extend WebdriverIO capabilities object
+ */
+export interface WDIOVSCodeServiceOptions {
+    [VSCODE_CAPABILITY_KEY]?: VSCodeOptions
+}
+
+export interface VSCodeCapabilities extends Capabilities.Capabilities, WDIOVSCodeServiceOptions {}
+
 /**
  * Settings to handle VSCode Proxy API
  */
@@ -99,10 +108,6 @@ export interface VSCodeOptions {
     vscodeProxyOptions: Partial<VSCodeProxyOptions>
 }
 
-export interface VSCodeCapabilities extends Capabilities.Capabilities {
-    [VSCODE_CAPABILITY_KEY]?: VSCodeOptions
-}
-
 export interface WDIOLogs {
     level: string
     message: string