Skip to content

fix(doc): Add "compilerOptions" to bun-types README.md #5325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2023

Conversation

philolo1
Copy link
Contributor

What does this PR do?

This updates the documentation for how to add bun-types.
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.

  • [ x ] Documentation or TypeScript types (it's okay to leave the rest blank in this case)

How did you verify your code works?

  • [ x ] Checked the readme on my pr

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.
@colinhacks colinhacks merged commit cb52556 into oven-sh:main Sep 14, 2023
@colinhacks
Copy link
Contributor

Thanks!

paperclover pushed a commit to SuperAuguste/bun that referenced this pull request Sep 18, 2023
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants