Update types to support promises in wrap (#2807)

cypress-io · Dec 3, 2018 · ca1139a · ca1139a
1 parent d57ca55
commit ca1139a
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/cli/types/index.d.ts b/cli/types/index.d.ts
@@ -1568,6 +1568,16 @@ declare namespace Cypress {
  * })
  */
  wrap<E extends Node = HTMLElement>(element: E | JQuery<E>, options?: Partial<Loggable & Timeoutable>): Chainable<JQuery<E>>
+ /**
+ * Yield the element passed into `.wrap()` to the next command in the Cypress chain.
+ *
+ * @see https://on.cypress.io/wrap
+ * @example
+ * cy.wrap(new Promise((resolve, reject) => {
+ * setTimeout(resolve, 1000);
+ * }).then(result => {})
+ */
+ wrap<F extends Promise<S>, S>(promise: F, options?: Partial<Loggable & Timeoutable>): Chainable<S>
  /**
  * Yields whatever is passed into `.wrap()` to the next command in the Cypress chain.
  *