Added back mention of required tsconfig options (#800)

jimp-dev · Sep 23, 2019 · 3b58221 · 3b58221
1 parent ee5a809
commit 3b58221
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/packages/jimp/README.md b/packages/jimp/README.md
@@ -63,7 +63,11 @@ If you're using this library with TypeScript the method of importing slightly di
 import Jimp from 'jimp';
 ```
 
-**Note**: This change in import does not change the runtime behavior of your code at all.
+This requires setting the `allowSyntheticDefaultImports` compiler option to `true` in your `tsconfig`
+
+**Note 1**: `esModuleInterop` implicitly sets `allowSyntheticDefaultImports` to `true`
+
+**Note 2**: `allowSyntheticDefaultImports` nor `esModuleInterop` change the runtime behavior of your code at all. They are just flags that tells TypeScript you need the compatibility they offer.
 
 ## Module Build