docs(typescript): add section about typescript support

m2sd · Dec 16, 2019 · 545d1df · 545d1df
1 parent 13715fc
commit 545d1df
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README-template.md b/README-template.md
@@ -44,6 +44,23 @@ or
 yarn add --dev @nuxtjs/axios @nuxtjs/proxy nuxt-laravel@next
 ```
 
+#### Typescript
+
+To have code completion/type checking on the `Configuration` interface from `@nuxt/types`, include the package in your `tsconfig.json`.
+
+```json
+{
+  "compilerOptions": {
+    // ...
+    "types": [
+        "@nuxt/types",
+        // ...
+        "nuxt-laravel"
+    ]
+  }
+}
+```
+
 ### Configuration
 
 Simply include `nuxt-laravel` in `modules` and set the `mode` setting to `'spa'` in your `nuxt.config.js`

diff --git a/README.md b/README.md
@@ -44,6 +44,23 @@ or
 yarn add --dev @nuxtjs/axios @nuxtjs/proxy nuxt-laravel@next
 ```
 
+#### Typescript
+
+To have code completion/type checking on the `Configuration` interface from `@nuxt/types`, include the package in your `tsconfig.json`.
+
+```json
+{
+  "compilerOptions": {
+    // ...
+    "types": [
+        "@nuxt/types",
+        // ...
+        "nuxt-laravel"
+    ]
+  }
+}
+```
+
 ### Configuration
 
 Simply include `nuxt-laravel` in `modules` and set the `mode` setting to `'spa'` in your `nuxt.config.js`