Nuxt Typescript

Nuxt Typescript is the official build and runtime support package that brings TypeScript to Nuxt 2 applications, distributed as the npm package @nuxt/types with documentation at typescript.nuxtjs.org. This repository, maintained by the Nuxt.js Team, provides the type definitions and tooling needed to write typed Vue applications on Nuxt 2, and is released under the MIT License.

What is Nuxt Typescript?

Nuxt Typescript is a build and runtime support package for TypeScript in Nuxt 2, created and maintained by the Nuxt.js Team. It takes a Nuxt 2 application and provides the TypeScript definitions, types, and runtime helpers needed to compile and run it with type safety. The project is distributed as the npm package @nuxt/types and is released under the MIT License.

Nuxt 2 historically required extra setup for TypeScript, and this package is the official way to add that support. The repository also hosts a documentation site at typescript.nuxtjs.org for setup guides, configuration, and usage details.

Key Features

• Build-time TypeScript support — Adds TypeScript integration to the Nuxt 2 build process, helping catch type errors during compilation.
• Runtime support — Provides runtime type augmentations so TypeScript understands Nuxt's runtime APIs and Vue component options.
• npm package distribution — Published as @nuxt/types, with an npm downloads badge showing active package usage.
• Dedicated documentation — Ships with a full docs site at typescript.nuxtjs.org covering installation and configuration for Nuxt 2.
• Automated CI testing — The repository uses GitHub Actions to run tests, as shown by the workflow status badge.
• Coverage tracking — Integrated with Codecov to track test coverage across the codebase.
• MIT License — All code is freely available under the MIT License, allowing commercial and personal use.

Who is it for?

Nuxt Typescript is for developers building applications with Nuxt 2 who want TypeScript to catch errors before runtime. It is used by Vue developers who prefer typed code, teams standardizing on TypeScript across a Nuxt 2 codebase, and maintainers of Nuxt modules who need to ship type definitions for their packages.

What can you do with it?

• Nuxt 2 application developers: Add the @nuxt/types package to a Nuxt 2 project to enable typed components, typed Nuxt configuration, and better IDE autocompletion.
• Teams migrating to TypeScript: Introduce TypeScript incrementally into an existing Nuxt 2 app using the official build and runtime support provided here.
• Nuxt module authors: Rely on the official Nuxt type definitions to write extensions and plugins that are type-safe and expose correct types to consumers.

FAQ

Is Nuxt Typescript free?

Yes, the project is fully open source under the MIT License, so it is free to use, modify, and redistribute for both commercial and personal projects.

What version of Nuxt does this support?

This package is specifically for Nuxt 2. The documentation and code are built around Nuxt 2's architecture, and it provides the TypeScript bridge that Nuxt 2 applications need.

Where can I find the documentation?

The official documentation is hosted at typescript.nuxtjs.org. The repository README links to that site as the primary source for setup and configuration instructions.