Update according to issue #317

dexie · Sep 21, 2016 · 6c3fe59 · 6c3fe59
1 parent a30faf7
commit 6c3fe59
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/samples/typescript/README.md b/samples/typescript/README.md
@@ -4,7 +4,7 @@ This is a sample on how to use Dexie.js with Typescript and babel. The following
 
 * How to subclass Dexie and define tables in a type-safe manner.
 * How to create an entity with Dexie.
-* How to use async / await with Dexie.
+* How to use async / await with Dexie **NOTE! Discouraged since Typescript 2.0. See [this issue](https://github.com/dfahlander/Dexie.js/issues/317)** 
 * How to create something similar to navigation properties on entities.
 
 ## Install

diff --git a/samples/typescript/src/app.ts b/samples/typescript/src/app.ts
@@ -1,4 +1,7 @@
-
+// DISCLAIMBER: This sample won't work with Typescript 2.0. Async / await is not encouraged any longer when using
+// indexedDB in any library due to the incompability between IndexedDB and native Promise in Firefox, Safari and
+// Edge browsers. See https://github.com/dfahlander/Dexie.js/issues/315
+
 import Dexie from 'dexie';
 import Console from './console';
 import {db,Contact} from './appdb';

diff --git a/samples/typescript/src/appdb.ts b/samples/typescript/src/appdb.ts
@@ -1,4 +1,8 @@
-import Dexie from 'dexie';
+// DISCLAIMBER: This sample won't work with Typescript 2.0. Async / await is not encouraged any longer when using
+// indexedDB in any library due to the incompability between IndexedDB and native Promise in Firefox, Safari and
+// Edge browsers. See https://github.com/dfahlander/Dexie.js/issues/315
+
+import Dexie from 'dexie';
 
 const Promise = Dexie.Promise; // KEEP! (or loose transaction safety in await calls!)
 const all = Promise.all;