Electron TypeScript Definitions
This module uses Electron's JSON API documentation to produce a TypeScript definition file for the Electron API.
Installation
npm install @electron/typescript-definitions --save
CLI Usage
To generate the definitions
electron-typescript-definitions --api=path/to/electron/api.json --outDir=path/to/out/dir
Any warnings during the generation can normally be ignored unless it actually throws
an error
Programmatic Usage
The module exports a function that parses a given API JSON object and returns
an array of lines to create the definition file
import { generateDefinitions } from '@electron/typescript-definitions'
const apiPath = './vendor/electron/docs/api.json'
const definitionLines = generateDefinitions({ electronApi: loadJSON(apiPath) })
// definitionLines will be an string representation of the definition file
License
MIT
@electron/typescript-definitions 是什么？ Automatically generated TypeScript definitions files for the Electron API
如何安装 @electron/typescript-definitions？ 在项目目录运行 npm install @electron/typescript-definitions，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 electron-typescript-definitions，可以用 npx electron-typescript-definitions 直接运行。
@electron/typescript-definitions 支持 TypeScript 吗？ 该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/electron__typescript-definitions 是否存在。
@electron/typescript-definitions 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@electron/typescript-definitions 需要什么版本的 Node.js？ package.json 的 engines 字段要求 Node.js >=22.12.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@electron/typescript-definitions 可以商用吗？ @electron/typescript-definitions 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@electron/typescript-definitions 的下载量有多少？ 根据 npm 官方下载统计，@electron/typescript-definitions 在 2026/10/14 – 2026/11/12 这 30 天内被下载 34,179 次，日均约 1,139 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@electron/typescript-definitions 还在维护吗？ 最新版本 10.0.0 发布于 2026/10/29（15 天前）；至今共发布 70 个版本，其中过去 12 个月发布了 4 个；首次发布于 2019/04/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。
