JSON 到 TypeScript
将普通的 JSON 示例转换为可读的 TypeScript 类型别名。检查可选字段和混合数组,然后复制代码或保存 TypeScript 文件。结果描述了观察到的结构和需求审查;它不会在运行时验证未来的数据。
从 JSON 生成类型
- 粘贴一个 JSON 文档或加载示例。在输入限制内支持对象、数组和基本类型的根值。注释、尾随逗号、解码后重复的键以及未配对的 UTF-16 代理码元会被拒绝。
- 选择以 ASCII 大写字母开头,后跟字母、数字或下划线的根类型名称,最多 64 个字符。选择两个或四个空格并生成类型。
- 检查推断字段和仅样本资格。 Copy 只写入当前代码;下载 TypeScript 保存与 json-types.ts 相同的 UTF-8 代码。编辑输入会清除旧结果。
样本推理的工作原理
基本值会推断为 null、boolean、number 或 string。看起来像日期、标识符或数字的字符串仍是字符串。数值标记无需转换即可分类;number 不保证 JavaScript 数值精度。
同一上下文中的对象会合并。只有当某个对象缺少该键时,该键才是可选的。显式 null 是一个值,因此可选与可为 null 不同。空对象也参与判断。
数组递归合并观察到的元素,而不是生成固定长度的元组。同一上下文中的空数组可使用非空数组的元素信息;如果没有任何元素,则使用 unknown[]。不同属性路径不会共享信息。
结果是一种具有内联嵌套类型、带引号的键和稳定格式的导出类型别名。没有键的对象池使用 unknown 值字符串索引签名,这是许可的而不是完全空的。不应用枚举、判别式、字典、日期或 UUID 启发式。
必需、可选和可为 null 的示例
示例中的第一个对象包含 id 1、label Ada 和 score null;第二个包含 id 2 和 score 4。id 和 score 在两个对象中都存在,因此是必需的。label 只出现一次,因此是可选的。score 的类型为 null | number。
对于 left 字段为空数组且 right 字段包含 1 的对象, left 保持为 unknown[] , right 变为 number[] 。对于两个对应的 items 数组(一个为空,一个包含 1),它们的共享元素证据会生成 number[] 。
合并带有 kind ok 和 value 的对象与带有 kind error 和 message 的对象后,kind 变为字符串,value 和 message 变为可选字段。原有的对应关系会丢失,类型可能允许样本中未出现的组合。需要可辨识联合类型时,请手动检查。
推理和大小限制
一个样本无法确定未来的每个字段、缺失值或变体。生成的声明是编译时类型,而不是运行时验证器、精确的对象模式或 API 响应正确性的证明。
输入限制为 256 KiB UTF-8 文本、深度 32 和 20000 条记录。每个 JSON 值计数一次,每个对象成员再添加两条记录。输出限制为 1 MiB,包括格式及其最终换行符。限制拒绝整个操作而不截断结果。
只允许在开头使用一个 BOM。作为互操作性限制,解码后重复的名称和未配对的 UTF-16 代理码元会被拒绝。数值标记最多 1024 个字符,指数绝对值最多 100000;不会推断 bigint 或保证数值精度。
该工具接受 JSON 文本并发出类型别名。它不会导入文件或 URL、执行示例、生成接口或运行时代码、推断 JSON 架构、翻译密钥或在浏览器中安装编译器。查看您将在其中使用它们的 TypeScript 项目中的声明。
示例和代码保留在此页面的工作流程中
本工具不会上传示例、保存历史记录、创建包含输入的链接,或添加包含 JSON、键名、类型名或生成代码的遥测数据。仅在请求时复制或下载。此说明不涵盖现有网站服务、扩展程序及您之后对代码的使用。
