Skip to content

Commit 5b6ec44

Browse files
docs: add additional steps for TypeScript projects (#24)
* docs: add additional steps for TypeScript projects * docs: formatting Co-authored-by: Yash Dave <87606277+yash-deepsource@users.noreply.github.com> Co-authored-by: Yash Dave <87606277+yash-deepsource@users.noreply.github.com>
1 parent 09a2c98 commit 5b6ec44

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,18 @@ yarn add @deepsource/nuxt-websocket # or npm install @deepsource/nuxt-websocket
3333
}
3434
```
3535

36+
### TypeScript
37+
38+
Add the types to your `types` array in `tsconfig.json` after the `@nuxt/types` (Nuxt 2.9.0+) entry.
39+
40+
```json
41+
{
42+
"compilerOptions": {
43+
"types": ["@nuxt/types", "@deepsource/nuxt-websocket"]
44+
}
45+
}
46+
```
47+
3648
## Options
3749

3850
You can pass different options using the `websocket` property in your `nuxt.config.js`.

0 commit comments

Comments
 (0)