Add typedefs (#67)

* add types * reference types * don't ignore types * don't lint typedefs * use optional peerdep for @wdio/types Co-authored-by: goosewobbler <[email protected]>
webdriverio-community · Jan 2, 2022 · 8d7fa35 · 8d7fa35
1 parent d7e497f
commit 8d7fa35
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1 +1,2 @@
 build/
+index.d.ts
diff --git a/.gitignore b/.gitignore
@@ -63,7 +63,6 @@ typings/
 
 **/build
 /*.js
-*.d.ts
 !babel.config.js
 !.eslintrc.js
 .DS_Store

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,13 @@
+import { Options, Services, Capabilities } from "@wdio/types";
+declare class ChromedriverServiceLauncher {
+    constructor(
+        options: Services.ServiceOption,
+        capabilities: Capabilities.Capabilities,
+        config: Omit<Options.Testrunner, "capabilities">
+    );
+
+    onComplete(): void;
+    onPrepare(): void;
+}
+export default class ChromeDriverService {}
+export declare const launcher: ChromedriverServiceLauncher;
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
   "homepage": "https://github.com/webdriverio-community/wdio-chromedriver-service#readme",
   "license": "MIT",
   "main": "./build",
+  "types": "index.d.ts",
   "engines": {
     "node": ">=10.0.0"
   },
@@ -39,7 +40,13 @@
   },
   "peerDependencies": {
     "chromedriver": "*",
-    "@wdio/cli": "^7.0.0"
+    "@wdio/cli": "^7.0.0",
+    "@wdio/types": "^7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@wdio/types": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@wdio/logger": "^7.5.3",