# TypeScript support

🚧 TypeScript documentation

This section is still a work in progress and will continue to be updated and improved. In the meantime, feel free to ask for help on the forum (opens new window) or on the community Discord (opens new window).

TypeScript adds an additional type system layer above JavaScript, which means that existing JavaScript code is also TypeScript code. Strapi supports TypeScript in new and existing projects running v4.2.0 and above. The core Developer Documentation contains code snippets in both JavaScript and TypeScript.

# Creating a new TypeScript project

Create a Strapi project with Typescript support by using the --ts or --typescript flags with either the npm or yarn package manager.

💡 TIP

Adding the --quickstart flag will create the project with an SQlite database.

# Understanding TypeScript support

When a Strapi project is created with TypeScript enabled, 2 tsconfig.json files are created (see project structure):

  • tsconfig.json file at the root of the project, to manage TypeScript compilation for the server
  • /src/admin/tsconfig.json to manage TypeScript compilation for the admin

TypeScript-enabled projects also contain a dist directory, which is used to compile the project JavaScript source code.

← Docker →