From ede61bd75ea65fceec37e4bcf258d2402a50baec Mon Sep 17 00:00:00 2001 From: Andy Matuschak Date: Fri, 13 Nov 2020 15:01:18 -0800 Subject: [PATCH 1/2] docs: add TypeScript workaround for #48 --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 4d4b5f50..b28d0b00 100644 --- a/README.md +++ b/README.md @@ -156,3 +156,8 @@ import the ones you need yourself. | `dag-pb` | `@ipld/dag-pb` | [ipld/js-dag-pb](https://github.com/ipld/js-dag-pb) | | `dag-jose` | `dag-jose`| [ceramicnetwork/js-dag-jose](https://github.com/ceramicnetwork/js-dag-jose) | + +# TypeScript support + +This project is distributed with type definitions for TypeScript. Unfortunately, due to [a bug in TypeScript](https://github.com/microsoft/TypeScript/issues/41258), you may notice some typechecking errors in these type definitions when compiling a project that uses them. As a workaround until the bug in TypeScript is fixed, you can set `skipLibCheck` to `true` in your `tsconfig.json` to suppress these errors. Please note that by enabling this option, the compiler will no longer check for errors in any of your dependencies' library type definitions. + From e5ba5a54549971e34668d36e2eed7cada9d65589 Mon Sep 17 00:00:00 2001 From: Andy Matuschak Date: Mon, 16 Nov 2020 09:25:29 -0800 Subject: [PATCH 2/2] Changing subhead level --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b28d0b00..be0375d5 100644 --- a/README.md +++ b/README.md @@ -157,7 +157,7 @@ import the ones you need yourself. | `dag-jose` | `dag-jose`| [ceramicnetwork/js-dag-jose](https://github.com/ceramicnetwork/js-dag-jose) | -# TypeScript support +## TypeScript support This project is distributed with type definitions for TypeScript. Unfortunately, due to [a bug in TypeScript](https://github.com/microsoft/TypeScript/issues/41258), you may notice some typechecking errors in these type definitions when compiling a project that uses them. As a workaround until the bug in TypeScript is fixed, you can set `skipLibCheck` to `true` in your `tsconfig.json` to suppress these errors. Please note that by enabling this option, the compiler will no longer check for errors in any of your dependencies' library type definitions.