From 9989af80d45e41ac80415423c5b347530896031b Mon Sep 17 00:00:00 2001 From: "Salau, Jenna (AU - Melbourne)" Date: Tue, 7 Feb 2017 18:13:51 +1100 Subject: [PATCH] Updated read me with typescript notes --- readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/readme.md b/readme.md index aa802b7..6b782d5 100644 --- a/readme.md +++ b/readme.md @@ -63,6 +63,14 @@ class MyApp extends ReactHabitat.Bootstrapper { export default new MyApp(); ``` +## TypeScript users please note +We are using Babel to transpile our code which wraps our modules in a "fake" module with a `default` property. TypeScript doesn't do any of the `default` wire up magic ([see here for more details](https://github.com/Microsoft/TypeScript/issues/2242#issuecomment-83694181)). + +So in order for TypeScript to consume our modules you will need to: + +* Change `ReactHabitat.Bootstrapper` for `ReactHabitat.default.Bootstrapper`; and +* Change `ReactHabitatRedux.Container` for `ReactHabitatRedux.default.Container` + ## Who is Deloitte Digital? **Part Business. Part Creative. Part Technology. One hundred per cent digital.**