diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-07-23 17:00:27 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-07-23 17:00:27 +0800 |
| commit | 4f73b81b9cb421817b56f747c367a02a37f16ce5 (patch) | |
| tree | f7f41c041d059c6e2a75acb074a6d454f238fdd8 /packages | |
| parent | b325ad17352f9418b6beb2d810b8b0c9c9f7bd23 (diff) | |
| download | dexon-0x-contracts-4f73b81b9cb421817b56f747c367a02a37f16ce5.tar.gz dexon-0x-contracts-4f73b81b9cb421817b56f747c367a02a37f16ce5.tar.zst dexon-0x-contracts-4f73b81b9cb421817b56f747c367a02a37f16ce5.zip | |
Add troubleshooting section to utils README
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/utils/README.md | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/packages/utils/README.md b/packages/utils/README.md index 82421e3ff..c9a2f5846 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -12,7 +12,6 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ```json "compilerOptions": { - "lib": ["dom"], "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], } ``` @@ -23,6 +22,21 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0xproject/utils'; ``` +## Troubleshooting + +If you are still seeing TS type errors complaining about missing DOM types such as `Response`: + +``` +error TS2304: Cannot find name 'Response'. +``` + +Then you need to explicitly add the `dom` lib to your compiler options in `tsconfig.json`. The `dom` library is included by default, but customizing the `lib` option can cause it to be dropped. + +``` +"compilerOptions": { + "lib": [..., "dom"], +``` + ## Contributing We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. |