docs: Add information about type checking to typescript.typeCheck c…

…onfig. #8630
nuxt · Nov 2, 2022 · 96372d7 · 96372d7
1 parent 491d02f
commit 96372d7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/schema/src/config/typescript.ts b/packages/schema/src/config/typescript.ts
@@ -22,6 +22,9 @@ export default defineUntypedSchema({
      * Enable build-time type checking.
      *
      * If set to true, this will type check in development. You can restrict this to build-time type checking by setting it to `build`.
+     * Requires to install `typescript` and `vue-tsc` as dev dependencies.
+     *
+     * @see https://v3.nuxtjs.org/guide/concepts/typescript#type-checking
      *
      * @type {boolean | 'build'}
      */