TypeScript

TypeScript adds an additional type system layer above JavaScript, which means that any valid JavaScript code is also valid TypeScript code. In the context of Strapi development, TypeScript allows for a more type-safe codebase for your application, and provides you with a set of tools for automatic type generation and autocompletion.

Getting Started with TypeScript in Strapi

Prerequisite

You're running Strapi version 4.3.0 and above.

There are 2 ways of getting started with TypeScript in Strapi:

• Create a new TypeScript project in Strapi by running the following command in a terminal (additional details can be found in the CLI installation documentation):

  Yarn

  yarn create strapi-app my-project --typescript

  NPM

  npx create-strapi-app@latest my-project --typescript

• Add TypeScript support to an existing Strapi project using the provided conversion steps.

What to do next?

• Understand the structure of a TypeScript-based Strapi project
• Learn about the configuration options options related to TypeScript
• Deep dive into TypeScript-related development options and features
• Read the guides below for specific use cases

Guides

Developing with TypeScript

Use typings, generate typings for your project schemas, and start Strapi programmatically.

Manipulating documents and entries

Explore TypeScript patterns for manipulating documents and entries.

Adding TypeScript support

Learn how to add TypeScript support to an existing Strapi project.