# @electron/typescript-definitions 中文文档

规范地址：https://npmcn.com/package/%40electron/typescript-definitions/

版本：10\.0\.0
npm 元数据更新时间：2026-10-28T19:00:38.942Z
中文译文更新时间：2026-11-13T12:01:50.448Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40electron/typescript-definitions
原文对照：https://npmcn.com/package/%40electron/typescript-definitions/?lang=original
项目主页：https://github.com/electron/typescript-definitions#readme
源码仓库：https://github.com/electron/typescript-definitions

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：111 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.12\.0
- 运行依赖：5 个
- 首次发布：2019-04-25T20:58:05.072Z
- 最新版本发布：2026-10-28T19:00:38.262Z
- 近 30 天下载量：34179（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：70（近 12 个月 4 个）

## 中文简介

为 Electron API 自动生成类型脚本定义文件

## 安装

```sh
npm install @electron/typescript-definitions
```

也可以使用：`pnpm add @electron/typescript-definitions`、`yarn add @electron/typescript-definitions`、`bun add @electron/typescript-definitions`

## README

# 电子类型脚本定义

![typescript-definitions-logo](https://npmcn.com/package/%40electron/typescript-definitions/design/logo.png)

此模块使用 Electron 的 [JSON API 文档](https://github.com/electron/docs-parser) 生成电子 API 的 TypeScript 定义文件.

[![Test](https://github.com/electron/typescript-definitions/actions/workflows/test.yml/badge.svg)](https://github.com/electron/typescript-definitions/actions/workflows/test.yml) [![npm version](http://img.shields.io/npm/v/@electron/typescript-definitions.svg)](https://npmjs.org/package/@electron/typescript-definitions)

## 安装

```sh
npm install @electron/typescript-definitions --save
```

## CLI 使用量

生成定义

```sh
electron-typescript-definitions --api=path/to/electron/api.json --outDir=path/to/out/dir
```

生成过程中的任何警告通常都可以被忽略,除非它实际投掷 错误

## 程序用途

模块导出一个分析给定 API JSON 对象并返回的函数 创建定义文件的行数组

```js
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
```

## 许可证

麻省理工学院

## 常见问题

### @electron/typescript-definitions 是什么？

为 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 和提交记录判断。