类型配置 TypeScript

如何配置 Strapi 进行 TypeScript 开发。

启用 TypeScript 的 Strapi 项目具有特定的项目结构,并通过 tsconfig.json 文件 处理 TypeScript 项目配置。

Strapi 还具有专用的 TypeScript 功能,这些功能在 config/typescript.js|ts 文件 中配置。

项目结构和 TypeScript 特定的配置文件

启用 TypeScript 的 Strapi 应用程序具有特定的 项目结构,其中包含以下专用文件夹和配置文件:

TypeScript 特定的目录和文件位置目的
./dist 目录应用程序根目录添加编译项目 JavaScript 源代码的位置。
build 目录./dist包含已编译的管理面板 JavaScript 源代码。该目录是在第一个 yarn buildnpm run build 命令上创建的
tsconfig.json 文件应用程序根目录管理服务器的 TypeScript 编译。
tsconfig.json 文件./src/admin/管理管理面板的 TypeScript 编译。

Strapi 特定的 TypeScript 配置

Strapi 生成的类型基于用户项目结构。一旦类型定义被发送到其专用文件中,Strapi 就会读取类型定义以相应地调整自动完成结果。

为了避免每次服务器重启时都必须 手动生成类型,基于 TypeScript 的项目会为您自动生成类型。但是,生成类型并不是基于 JavaScript 的项目的必要条件,因此,如果您愿意,可以通过创建可选的 config/typescript.js|ts 配置文件并将 autogenerate 参数设置为 false 来关闭类型自动生成:

参数说明类型默认
autogenerate在服务器重启时启用或禁用自动类型生成Booleantrue
./config/typescript.js
js
module.exports = ({ env }) => ({
  autogenerate: false,
})
实验性。

关闭 JavaScript 项目的类型自动生成被视为实验性的,可能会出现问题或破坏某些功能。