TypeScript 配置

页面摘要: TypeScript 配置解释了项目的 tsconfig 文件、输出目录,以及一个可选的 config/typescript.js|ts,它会在服务器重启时自动生成类型。本文档说明了哪些文件夹存储编译后的代码,以及如何切换此实验性功能。

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

Strapi 还有专门的 TypeScript 功能,在 config/typescript.js|ts 文件 中进行配置。

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

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

TypeScript 专用目录和文件LocationPurpose
./dist 目录应用根目录添加用于编译项目 JavaScript 源代码的位置。
build 目录./dist包含编译后的管理面板 JavaScript 源代码。该目录在首次 yarn build 或 npm run build 命令时创建
tsconfig.json 文件应用根目录管理服务器端的 TypeScript 编译。
tsconfig.json 文件./src/admin/管理管理面板的 TypeScript 编译。

Strapi 特定的 TypeScript 配置

🚧 此功能被视为实验性。

这些设置被视为实验性,可能存在问题或破坏某些功能。

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

为了避免每次服务器重启时都要手动生成类型,可以添加一个可选的 config/typescript.js|ts 配置文件,该文件目前只接受一个参数:

ParameterDescriptionTypeDefault
autogenerate在服务器重启时启用或禁用自动类型生成Booleanfalse

示例:

JavaScript

module.exports = ({ env }) => ({
  autogenerate: true,
});

TypeScript

export default ({ env }) => ({
  autogenerate: true,
});