diff --git a/deploy/readmes/audioworklet.md b/deploy/readmes/audioworklet.md index 37f6c7e9a..8a7be1989 100644 --- a/deploy/readmes/audioworklet.md +++ b/deploy/readmes/audioworklet.md @@ -16,6 +16,8 @@ To use `@types/audioworklet` you need to do two things: 1. **Without "lib"** - You will need to add `"lib": []`. The value you want to add inside your lib should correlate to your [`"target"`](https://www.typescriptlang.org/tsconfig#target). For example if you had `"target": "es2017"`, then you would add `"lib": ["es2017"]` 1. **With "lib"** - You should remove `"dom"`. +1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`. + That's all. If you'd like to ensure that the DOM types are never accidentally included, you can use [@orta/types-noop](https://www.npmjs.com/package/@orta/type-noops) in TypeScript 4.5+. diff --git a/deploy/readmes/serviceworker.md b/deploy/readmes/serviceworker.md index bc800dc84..c5d65a270 100644 --- a/deploy/readmes/serviceworker.md +++ b/deploy/readmes/serviceworker.md @@ -16,6 +16,8 @@ To use `@types/serviceworker` you need to do two things: 1. **Without "lib"** - You will need to add `"lib": []`. The value you want to add inside your lib should correlate to your [`"target"`](https://www.typescriptlang.org/tsconfig#target). For example if you had `"target": "es2017"`, then you would add `"lib": ["es2017"]` 1. **With "lib"** - You should remove `"dom"`. +1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`. + That's all. If you'd like to ensure that the DOM types are never accidentally included, you can use [@orta/types-noop](https://www.npmjs.com/package/@orta/type-noops) in TypeScript 4.5+. diff --git a/deploy/readmes/sharedworker.md b/deploy/readmes/sharedworker.md index 91559f149..eef73f6d1 100644 --- a/deploy/readmes/sharedworker.md +++ b/deploy/readmes/sharedworker.md @@ -17,6 +17,7 @@ To use `@types/sharedworker` you need to do two things: 1. **Without "lib"** - You will need to add `"lib": []`. The value you want to add inside your lib should correlate to your [`"target"`](https://www.typescriptlang.org/tsconfig#target). For example if you had `"target": "es2017"`, then you would add `"lib": ["es2017"]` 1. **With "lib"** - You should remove `"dom"`. +1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`. If you'd like to ensure that the DOM types are never accidentally included, you can use [@orta/types-noop](https://www.npmjs.com/package/@orta/type-noops) in TypeScript 4.5+. diff --git a/deploy/readmes/web.md b/deploy/readmes/web.md index abf0e19ae..47b79b735 100644 --- a/deploy/readmes/web.md +++ b/deploy/readmes/web.md @@ -16,6 +16,8 @@ npm install @typescript/lib-dom@npm:@types/web --save-dev yarn add @typescript/lib-dom@npm:@types/web --dev ``` +If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`. + That's all.
diff --git a/deploy/readmes/webworker.md b/deploy/readmes/webworker.md index 521159292..f1eb07ddd 100644 --- a/deploy/readmes/webworker.md +++ b/deploy/readmes/webworker.md @@ -16,6 +16,8 @@ npm install @typescript/lib-webworker@npm:@types/webworker --save-dev yarn add @typescript/lib-webworker@npm:@types/webworker --dev ``` +If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`. + That's all.