aboutsummaryrefslogtreecommitdiff
path: root/docs/quickstart.md
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-20 16:32:51 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-09-20 16:32:51 -0700
commitbbff5b77358151c7e203cb4f9278aa17f284cde9 (patch)
treea3e44c1c54b5d9f42319323cb373b3f53718e21c /docs/quickstart.md
parent2e06dbaffe1188caf0a0d2f9b1a4c819369caa53 (diff)
downloadbun-bbff5b77358151c7e203cb4f9278aa17f284cde9.tar.gz
bun-bbff5b77358151c7e203cb4f9278aa17f284cde9.tar.zst
bun-bbff5b77358151c7e203cb4f9278aa17f284cde9.zip
Update quickstart
Diffstat (limited to 'docs/quickstart.md')
-rw-r--r--docs/quickstart.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md
index 9b46d4501..c71c3c50f 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -42,6 +42,25 @@ const server = Bun.serve({
console.log(`Listening on http://localhost:${server.port} ...`);
```
+<!--
+### TypeScript
+
+If you're using TypeScript, you may see a type error on the `Bun` global. To fix this, install `bun-types`.
+
+```sh
+$ bun add -d bun-types
+```
+
+Then add the following line to your `compilerOptions` in `tsconfig.json`.
+
+```json-diff#tsconfig.json
+{
+ "compilerOptions": {
++ "types": ["bun-types"]
+ }
+}
+``` -->
+
Run the file from your shell.
```bash