Skip to main content

TypeScript 配置

¥TypeScript configuration

支持 TypeScript 的 Strapi 项目具有特定的项目结构,并通过 tsconfig.json files 处理 TypeScript 项目配置。

¥TypeScript-enabled Strapi projects have a specific project structure and handle TypeScript project configuration through tsconfig.json files.

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

¥Strapi also has dedicated TypeScript features that are configured in the config/typescript.js|ts file.

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

¥Project structure and TypeScript-specific configuration files

支持 TypeScript 的 Strapi 应用有一个特定的 项目结构,其中包含以下专用文件夹和配置文件:

¥TypeScript-enabled Strapi applications have a specific project structure with the following dedicated folders and configuration files:

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

TypeScript 的 Strapi 特定配置

¥Strapi-specific configuration for TypeScript

🚧 此功能被视为实验性的。

这些设置被视为实验性的,可能会出现问题或破坏某些功能。

¥These settings are considered experimental and might have issues or break some features.

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

¥Types generated by Strapi are based on the user project structure. Once the type definitions are emitted into their dedicated files, Strapi reads the type definitions to adapt the autocompletion results accordingly.

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

¥To avoid having to manually generate types every time the server restarts, an optional config/typescript.js|ts configuration file can be added, which currently accepts only one parameter:

范围描述类型默认
autogenerate启用或禁用服务器重新启动时自动生成类型Booleanfalse

示例:

¥Example:

./config/typescript.js
module.exports = ({ env }) => ({
autogenerate: true,
});