文档 类型生成

类型生成

为类型安全的翻译键自动生成 TypeScript 定义,并提供完整的 IDE 自动补全功能。

工作原理

运行 i1n pull 时,CLI 会生成一个 i1n.d.ts 文件,其中包含项目中所有翻译键的 TypeScript 类型定义。

此文件将每个翻译键映射到其点表示法路径,提供编译时验证和完整的 IDE 自动补全功能。

优势

类型安全的翻译键可消除因拼写错误或缺少键而导致的运行时错误。您的 IDE 会在您键入时显示所有可用键,并提供自动补全建议。

重构是安全的:在源代码中重命名一个键可以在整个代码库的编译时被捕获。

用法

生成的 i1n.d.ts 文件会自动包含在您的 TypeScript 编译中。切勿直接修改此文件 — 每次执行 i1n pull 时都会重新生成它。

从 i1n.d.ts 导入类型安全的键常量,并将其与翻译函数一起使用,以确保正确性。

i1n.d.ts
export const common = {
  greeting: "common.greeting",
  errors: {
    not_found: "common.errors.not_found"
  }
} as const;

相关