[selenium-webdriver] Allow Condition.fn to return Promise<T> and null (…

…DefinitelyTyped#53444)
catlan · May 27, 2021 · c740cad · c740cad
1 parent c51eb58
commit c740cad
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/types/selenium-webdriver/index.d.ts b/types/selenium-webdriver/index.d.ts
@@ -308,6 +308,8 @@ export namespace error {
   function encodeError(err: any): {error: string, message: string};
 }
 
+type ConditionFn<T> = (webdriver: WebDriver) => T | null | Promise<T | null>;
+
 /**
  * Defines a condition for use with WebDriver's WebDriver#wait wait command.
  */
@@ -319,13 +321,13 @@ export class Condition<T> {
    *     evaluate on each iteration of the wait loop.
    * @constructor
    */
-  constructor(message: string, fn: (webdriver: WebDriver) => T);
+  constructor(message: string, fn: ConditionFn<T>);
 
   /** @return {string} A description of this condition. */
   description(): string;
 
   /** @type {function(!WebDriver): OUT} */
-  fn(webdriver: WebDriver): T;
+  fn(webdriver: WebDriver): ConditionFn<T>;
 }
 
 /**

diff --git a/types/selenium-webdriver/test/index.ts b/types/selenium-webdriver/test/index.ts
@@ -524,6 +524,11 @@ function TestWebElementPromise() {
     elementPromise.then((element: webdriver.WebElement) => 'foo', (error: any) => 'bar').then((result: string) => {});
 }
 
+function testCondition() {
+    const conditionString = new webdriver.Condition<string>('message', () => Math.random() > 0.5 ? 'foo' : null);
+    const conditionStringPromise = new webdriver.Condition<string>('message', async () => Math.random() > 0.5 ? 'foo' : null);
+}
+
 declare let stringPromise: Promise<string>;
 
 function TestUntilModule() {