aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Patrick Klitzke <philologos14@gmail.com> 2023-09-14 11:27:49 +0900
committerGravatar GitHub <noreply@github.com> 2023-09-13 19:27:49 -0700
commitcb52556bd1669d0b23e705d82284b673f8f1cd4c (patch)
treedefcfc643ba057abcfda1fe5c75ec3f708aac6fa
parent03d9bcd440bd74cf21f4ac9ec1919ad074077231 (diff)
downloadbun-cb52556bd1669d0b23e705d82284b673f8f1cd4c.tar.gz
bun-cb52556bd1669d0b23e705d82284b673f8f1cd4c.tar.zst
bun-cb52556bd1669d0b23e705d82284b673f8f1cd4c.zip
fix(doc): Add "compilerOptions" to bun-types README.md (#5325)
Reading the documentation on bun-types it was not clear to me that the tsconfig.ts needs to look like this: ``` { "compilerOptions": { "types": ["bun-types"] } } ``` So i added the "compilerOptions" information.
-rw-r--r--packages/bun-types/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/packages/bun-types/README.md b/packages/bun-types/README.md
index a4ca166a6..c11c1371d 100644
--- a/packages/bun-types/README.md
+++ b/packages/bun-types/README.md
@@ -21,9 +21,11 @@ Add this to your `tsconfig.json` or `jsconfig.json`:
```jsonc-diff
{
-
-+ "types": ["bun-types"],
-
+ "compilerOptions": {
++ "types": ["bun-types"]
+ // other options...
+ }
+
// other options...
}
```