Fix : Add tag_filter type to NightwatchOptions interface. #3825 (#3830)

nightwatchjs · Aug 9, 2023 · 6e36f45 · 6e36f45
1 parent 50c9dbf
commit 6e36f45
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -567,7 +567,7 @@ export interface NightwatchAPI
    */
   setSessionId(sessionId: string): this;
 
-  options: NightwatchTestOptions;
+  options: NightwatchOptions & Pick<NightwatchTestOptions, "desiredCapabilities">;
 
   Keys: NightwatchKeys;
 

diff --git a/types/nightwatch-options.d.ts b/types/nightwatch-options.d.ts
@@ -129,6 +129,7 @@ export interface NightwatchScreenshotOptions {
 }
 
 export interface NightwatchOptions {
+
 	/**
 	 * Location(s) where custom commands will be loaded from.
 	 */
@@ -435,6 +436,12 @@ export interface NightwatchOptions {
 	 */
 	skiptags?: string;
 
+	/**
+	 * Tag(s) used/to be used during test execution.
+	 * Can be a single tag or an array of tags.
+	 */
+	tag_filter?: string | string[];
+
 	/**
 	 * Use xpath as the default locator strategy.
 	 */

diff --git a/types/tests/index.test-d.ts b/types/tests/index.test-d.ts
@@ -34,6 +34,8 @@ const testGeneral: NightwatchTests = {
   'Demo test Google 1': () => {
     browser.registerBasicAuth('test-username', 'test-password').navigateTo('https://google.com').pause(1000);
 
+    // check types on browser.options
+    expectType<string | string[] | undefined>(browser.options.tag_filter);
     // expect element <body> to be present in 1000ms
     browser.expect.element('body').to.be.present.before(1000);