Skip to content

Commit 52dadb5

Browse files
authored
Mention libReplacement in READMEs (#2474)
1 parent 98a884e commit 52dadb5

5 files changed

Lines changed: 9 additions & 0 deletions

File tree

deploy/readmes/audioworklet.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ To use `@types/audioworklet` you need to do two things:
1616
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"]`
1717
1. **With "lib"** - You should remove `"dom"`.
1818

19+
1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`.
20+
1921
That's all.
2022

2123
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+.

deploy/readmes/serviceworker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ To use `@types/serviceworker` you need to do two things:
1616
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"]`
1717
1. **With "lib"** - You should remove `"dom"`.
1818

19+
1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`.
20+
1921
That's all.
2022

2123
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+.

deploy/readmes/sharedworker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ To use `@types/sharedworker` you need to do two things:
1717
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"]`
1818
1. **With "lib"** - You should remove `"dom"`.
1919

20+
1. If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`.
2021

2122
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+.
2223

deploy/readmes/web.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ npm install @typescript/lib-dom@npm:@types/web --save-dev
1616
yarn add @typescript/lib-dom@npm:@types/web --dev
1717
```
1818

19+
If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`.
20+
1921
That's all.
2022

2123
<details>

deploy/readmes/webworker.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ npm install @typescript/lib-webworker@npm:@types/webworker --save-dev
1616
yarn add @typescript/lib-webworker@npm:@types/webworker --dev
1717
```
1818

19+
If you are using TypeScript 6.0+, set [`libReplacement`](https://www.typescriptlang.org/tsconfig/#libReplacement) to `true` in your `tsconfig.json`.
20+
1921
That's all.
2022

2123
<details>

0 commit comments

Comments
 (0)