From 243426f9854ea97c8a5cc6740252d40841efd23f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20B=C3=A4r?= <teggno@hotmail.com>
Date: Mon, 21 Jan 2019 16:06:11 +0100
Subject: [PATCH] Add comment for new dexpect constant.

---
 types/detox/index.d.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/types/detox/index.d.ts b/types/detox/index.d.ts
index 8ed9d4a9e8..bcf914fac4 100644
--- a/types/detox/index.d.ts
+++ b/types/detox/index.d.ts
@@ -8,6 +8,12 @@ declare global {
     const device: Detox.Device;
     const element: Detox.Element;
     const waitFor: Detox.WaitFor;
+    /**
+     * `dexpect` ("Detox-expect") intentionally has the same type as `expect`.
+     * `expect` conflicts with the global `expect` of jest and therefore
+     * exporting it doesn't work which is why `dexpect` was introduced. `expect`
+     * is kept for backwards compatibility.
+     */
     const dexpect: Detox.Expect<Detox.Expect<any>>;
     const expect: Detox.Expect<Detox.Expect<any>>;
     const by: Detox.Matchers;