docs: Add note about allowSyntheticDefaultExports

mocks-server · Aug 10, 2022 · 0db25ce · 0db25ce
1 parent a7fc36f
commit 0db25ce
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/packages/cypress-commands/README.md b/packages/cypress-commands/README.md
@@ -192,12 +192,13 @@ describe("users page", () => {
 
 For those writing [TypesScript tests in Cypress][cypress-typescript], this package includes TypeScript declarations.
 
-Add "@mocks-server/cypress-commands" to the `types` property in the `tsconfig.json` file:
+Add "@mocks-server/cypress-commands" to the `types` property in the `tsconfig.json` file. You may also need to set the TS `allowSyntheticDefaultImports` option to true:
 
 ```json
 {
   "compilerOptions": {
-    "types": ["cypress", "@mocks-server/cypress-commands"]
+    "types": ["cypress", "@mocks-server/cypress-commands"],
+    "allowSyntheticDefaultImports": true
   }
 }
 ```