Skip to content

Commit

Permalink
fix(doc): Add "compilerOptions" to bun-types README.md (#5325)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
philolo1 committed Sep 14, 2023
1 parent 03d9bcd commit cb52556
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions packages/bun-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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...
}
```
Expand Down

0 comments on commit cb52556

Please sign in to comment.