From 7297dd42e0a1e674127fd2988e5183c844c2e487 Mon Sep 17 00:00:00 2001
From: Mike Cann <mike.cann@gmail.com>
Date: Fri, 6 Oct 2017 13:36:36 +0800
Subject: [PATCH] updated readme to warn about known typescript issue

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index 008470023..dbe2e2e59 100644
--- a/README.md
+++ b/README.md
@@ -1036,6 +1036,55 @@ const Example = types
   });
 ```
 
+#### Known Typescript Issue 5938
+
+Theres a known issue with typescript and interfaces as described by: https://github.com/Microsoft/TypeScript/issues/5938
+
+This rears its ugly head if you try to define a model such as:
+
+```typescript
+import { types } from "mobx-state-tree"
+
+export const Todo = types.model({
+    title: types.string
+});
+
+export type ITodo = typeof Todo.Type
+```
+
+And you have your tsconfig.json settings set to:
+
+```json
+{
+  "compilerOptions": {
+    ...
+    "declaration": true,    
+    "noUnusedLocals": true
+    ...
+  }
+}
+```
+
+Then you will get errors such as:
+
+> error TS4023: Exported variable 'Todo' has or is using name 'IModelType' from external module "..." but cannot be named.
+
+Until Microsoft fixes this issue the solution is to re-export IModelType:
+
+```typescript
+import { types, IModelType } from "mobx-state-tree"
+
+export type __IModelType = IModelType<any,any>;
+
+export const Todo = types.model({
+    title: types.string
+});
+
+export type ITodo = typeof Todo.Type
+```
+
+It aint pretty, but it works.
+
 ### How does MST compare to Redux
 
 So far this might look a lot like an immutable state tree as found for example in Redux apps, but there are a few differences: