# @frequency-chain/api-augment 中文文档

规范地址：https://npmcn.com/package/%40frequency-chain/api-augment/

版本：3\.0\.0
npm 元数据更新时间：2026-07-22T03:53:54.557Z
中文译文更新时间：2026-11-15T13:46:01.354Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.1 MB，133 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-09-23T11:17:05.974Z
- 最新版本发布：2026-07-22T03:53:54.180Z
- 近 30 天下载量：303415（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：785（近 12 个月 16 个）

## 中文简介

Polkadotjs API 使用的频率的 RPC 配置

## 安装

```sh
npm install @frequency-chain/api-augment
```

也可以使用：`pnpm add @frequency-chain/api-augment`、`yarn add @frequency-chain/api-augment`、`bun add @frequency-chain/api-augment`

## README

# Javascript 自定义 RPC

[![Contributors](https://img.shields.io/github/contributors/frequency-chain/frequency.svg?style=for-the-badge)](https://github.com/frequency-chain/frequency/graphs/contributors) [![Forks](https://img.shields.io/github/forks/frequency-chain/frequency.svg?style=for-the-badge)](https://github.com/frequency-chain/frequency/network/members) [![Stargazers](https://img.shields.io/github/stars/frequency-chain/frequency.svg?style=for-the-badge)](https://github.com/frequency-chain/frequency/stargazers) [![Issues](https://img.shields.io/github/issues/frequency-chain/frequency.svg?style=for-the-badge)](https://github.com/frequency-chain/frequency/issues) [![MIT License](https://img.shields.io/github/license/frequency-chain/frequency.svg?style=for-the-badge)](https://github.com/frequency-chain/frequency/blob/master/LICENSE) [![NPM @latest](https://img.shields.io/npm/v/@frequency-chain/api-augment?label=npm%20%40latest&style=for-the-badge)](https://www.npmjs.com/package/@frequency-chain/api-augment) [![NPM @next](https://img.shields.io/npm/v/@frequency-chain/api-augment/next?label=npm%20%40next&style=for-the-badge)](https://www.npmjs.com/package/@frequency-chain/api-augment)

# Polkadot JS API的频率自定义RPC和类型

一个容易获得所有自定义 rpc 和类型配置以方便使用的方法 [频率](https://github.com/frequency-chain/frequency/) 与 [Polkadot JS API图书馆](https://www.npmjs.com/package/@polkadot/api) 使用 TypeScript.

## 开始

-   `npm install @frequency-chain/api-augment` (API 增强库)
-   `npm install @polkadot/api` (Polkadot API 图书馆)

## 升级和匹配版本

假设你没有使用被贬损的方法,任何发布版本都应该与发布版本相对抗 `@frequency-chain/api-augment`。 。 。 . 如果您正在对开发版本进行工作, 则建议您与使用 `v0.0.0-[First 6 of the commit hash]`。 。 。 .

Changelog 维护在 [频率释放](https://github.com/frequency-chain/frequency/releases)。 。 。 .

### 使用量

关于使用详情,见 [Polkadot API 库文档](https://polkadot.js.org/docs/api)。 。 。 .

```typescript
import { options } from "@frequency-chain/api-augment";
import { ApiPromise } from "@polkadot/api";
// ...

const api = await ApiPromise.create({
  ...options,
  // ...
});
```

## 捐款

见 [捐款额](https://npmcn.com/package/%40frequency-chain/api-augment/CONTRIBUTING.md) 更多信息.

### 更新定义

更新 `./definitions` 如果您更改了任何类型或RPC电话.

生成 JS 类定义, 运行

```
make js
```

此命令将启动背景中的频率节点并从中获取 API 定义 。 要停止频率进程,请使用命令的PID输出.

## 帮助笔记

### 未解决自定义 RPC

Api 增强宣告所使用的模块 `@polkadot/api`。 。 。 . 因此,输入用于 `@frequency-chain/api-augment` 一定要早点来 `@polkadot/api` 因此,频率申报首先解决.

```typescript
import { options } from "@frequency-chain/api-augment";
// Or
import "@frequency-chain/api-augment";
// Must come BEFORE any imports from @polkadot/api
import { ApiPromise } from "@polkadot/api";
```

Caches即使重新订购也会毁了它 所以小心点.

-   Yarn 缓存有时会引起问题( 如果您正在使用纱线): `yarn cache clear`
-   有时我发现吹走 `node_modules` 帮助: `rm -Rf node_modules`

### 选项

可选反应没有映射到 `null` ,然后返回一个带有少数属性的对象. 详情见 [选项类的代码](https://github.com/polkadot-js/api/blob/master/packages/types-codec/src/base/Option.ts)。 。 。 .

```javascript
const optionalExample = await api.rpc.schemas.getBySchemaId(1);
// Does the Option have a value?
if (!optionalExample.isEmpty) {
  // Get the value
  return optionalExample.value;
}
return null;
```

### 电视

矢量响应没有被直接映射到JavaScript阵列. 相反,他们被绘制到 [菜类](https://github.com/polkadot-js/api/blob/master/packages/types-codec/src/base/Vec.ts) 扩展 [阵列](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)。 。 。 . 这样,你还可以使用 `map`, (中文(简体) ), `forEach`等,有回复或访问通过 `.values()`。 。 。 .

## 许可证

根据Apache 2.0 许可证分发。 见 `LICENSE` 更多信息.

## 常见问题

### @frequency-chain/api-augment 是什么？

Polkadotjs API 使用的频率的 RPC 配置

### 如何安装 @frequency-chain/api-augment？

在项目目录运行 npm install @frequency-chain/api-augment，或使用 pnpm add / yarn add / bun add。

### @frequency-chain/api-augment 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @frequency-chain/api-augment 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @frequency-chain/api-augment 可以商用吗？

@frequency-chain/api-augment 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @frequency-chain/api-augment 的下载量有多少？

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

### @frequency-chain/api-augment 还在维护吗？

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