# @edgeware/node-types 中文文档

规范地址：https://npmcn.com/package/%40edgeware/node-types/

版本：3\.6\.2-wako
npm 元数据更新时间：2022-04-05T06:41:56.812Z
中文译文更新时间：2026-11-13T06:48:40.207Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：652 kB，84 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=14\.0\.0
- 运行依赖：0 个
- 首次发布：2020-07-15T17:07:16.538Z
- 最新版本发布：2021-07-09T15:31:00.058Z
- 近 30 天下载量：291476（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 0 个）

## 中文简介

边缘软件链的类型定义 .

## 安装

```sh
npm install @edgeware/node-types
```

也可以使用：`pnpm add @edgeware/node-types`、`yarn add @edgeware/node-types`、`bun add @edgeware/node-types`

## README

# 边缘软件节点类型

## 使用量

此 repo 包含自定义边缘软件- 节点模块的 Typescript 绑定 .

要对 Edgeware 使用标准 API, 您必须初始化 API 的选项对象如下 :

```
import { spec } from '@edgeware/node-types';

const options: ApiOptions = {
  provider : new WsProvider('ws://localhost:9944'),
  ...spec,
};

const api = new ApiPromise(options);
```

您还需要更新 `tsconfig.json` 包括以下内容的项目:

```
{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@polkadot/api/augment": ["./node_modules/@edgeware/node-types/interfaces/augment-api.d.ts"],
      "@polkadot/types/augment": ["./node_modules/@edgeware/node-types/interfaces/augment-types.d.ts"],
    }
  }
}
```

### 依赖关系

您的项目是 @ polkadot-js 依赖版本 **必须匹配此工程所使用的版本**,包括: `@polkadot/api`, (中文(简体) ), `@polkadot/keyring`软件包,以及 `rxjs` (如果使用 `ApiRx` 改为 `ApiPromise`和 `typescript`。为了验证所需的版本,请检查 @polkadot package.json文件,以查看本项目的软件包所指定的版本.json.

## 大楼

这个项目取决于 [@ polkadot/ 类型源](https://github.com/polkadot-js/api/tree/master/docs/examples/promise/90_typegen) 项目,它有逐步建设该项目的指南.

边缘专用版本如下:

1.  确保 [软件包.json](https://npmcn.com/package/%40edgeware/node-types/package.json) 那个 `@polkadot/api` 设置为正确的版本,并且 `@polkadot/typegen` 设置为与 `@polkadot/api`。增加 `@edgeware/node-types` 必要时出版.
    
2.  确保所有 `definitions.ts` 文件在 `src/interfaces` 如果边缘软件模块有变化,则更新到每种类型的最新版本.
    
3.  运行一个 [边缘软件节点](https://github.com/hicommonwealth/edgeware-node) 在本地主机的链条。 然后,运行 `./generateMetadata.bash` 更新 `edgeware.json` 文档.
    
4.  一旦你有一个 `edgeware.json` 文件中,您可以用 :
    
    ```
    $ yarn generate
    $ yarn lint
    ```
    
5.  您将注意到, Lint 命令的输出包含一个错误 。 这是因为"类型"脚本对互相依赖的自定义模块的相对路径处理不当. 您必须手动更改为 [信号/类型.ts](https://npmcn.com/package/%40edgeware/node-types/src/interfaces/signaling/types.ts) 内容如下:
    
    ```diff
    - import { VoteStage } from './voting';
    + import { VoteStage } from '../voting';
    ```
    
6.  全部升级 [光谱文件](https://npmcn.com/package/%40edgeware/node-types/src/spec) ,并按 [@polkadot-js changlog (变换日志)](https://github.com/polkadot-js/api/blob/master/CHANGELOG.md) 和下层的链条.
    
7.  要将 Typescript 编译为 npm 出版的 Javascript, 运行 `yarn build`。此命令不应产生任何错误,并将将构建文件输出到 [数字](https://npmcn.com/package/%40edgeware/node-types/dist/) 目录.
    
8.  运行一个对新建的 API 的简单测试 `yarn verify [mainnet | beresheet]`。 。 。 .
    
9.  以 `npm publish`。 。 。 .

## 常见问题

### @edgeware/node-types 是什么？

边缘软件链的类型定义 \.

### 如何安装 @edgeware/node-types？

在项目目录运行 npm install @edgeware/node-types，或使用 pnpm add / yarn add / bun add。

### @edgeware/node-types 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/edgeware\_\_node-types 是否存在。

### @edgeware/node-types 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @edgeware/node-types 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=14\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @edgeware/node-types 可以商用吗？

@edgeware/node-types 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @edgeware/node-types 的下载量有多少？

根据 npm 官方下载统计，@edgeware/node-types 在 2026/10/13 – 2026/11/11 这 30 天内被下载 291,476 次，日均约 9,716 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @edgeware/node-types 还在维护吗？

最新版本 3\.6\.2-wako 发布于 2021/07/09（5 年前）；至今共发布 62 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/07/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。