Skip to content

Commit c8245d7

Browse files
committed
docs: Added typescript documentation
1 parent 18f6a0d commit c8245d7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,25 @@ npm i rxjs --save (because this is a peer dependency of the Kentico Kontent Deli
5353
### Note:
5454
By default Nuxt can only work with promises. Therefor you always use the "toPromise" method provided by the Kentico Kontent Delivery SDK! RxJs operator's are not supported at the moment.
5555

56+
# Typescript
57+
58+
Since version 7 the kentico-kontent-nuxt-module has typescript support!
59+
60+
Add the types to your "types" array in tsconfig.json after the @nuxt/types (Nuxt 2.9.0+) or @nuxt/vue-app entry
61+
62+
```json
63+
64+
{
65+
"compilerOptions": {
66+
"types": [
67+
"@nuxt/types",
68+
"kentico-kontent-nuxt-module"
69+
]
70+
}
71+
}
72+
73+
```
74+
5675
## Generating
5776
When using a static generated deployment you may need to use the [items-feed](https://docs.kontent.ai/reference/api-changelog#a-delivery-api-limitation) endpoint when generating your site (because the items endpoint has a rate limitation).
5877

0 commit comments

Comments
 (0)