@frequency-chain/api-augment

中文文档
3.0.0发布于 2026/07/22Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 30.3万

Polkadotjs API 使用的频率的 RPC 配置

中文使用文档
文档目录10 节
  1. 开始
  2. 升级和匹配版本
  3. 使用量
  4. 捐款
  5. 更新定义
  6. 帮助笔记
  7. 未解决自定义 RPC
  8. 选项
  9. 电视
  10. 许可证

Javascript 自定义 RPC

Contributors Forks Stargazers Issues MIT License NPM @latest NPM @next

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

一个容易获得所有自定义 rpc 和类型配置以方便使用的方法 频率 与 Polkadot JS 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 维护在 频率释放。 。 。 .

使用量

关于使用详情,见 Polkadot API 库文档。 。 。 .

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

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

捐款

见 捐款额 更多信息.

更新定义

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

生成 JS 类定义, 运行

make js

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

帮助笔记

未解决自定义 RPC

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

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 ,然后返回一个带有少数属性的对象. 详情见 选项类的代码。 。 。 .

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阵列. 相反,他们被绘制到 菜类 扩展 阵列。 。 。 . 这样,你还可以使用 map, (中文(简体) ), forEach等,有回复或访问通过 .values()。 。 。 .

许可证

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

版本与发布记录

@frequency-chain/api-augment 共发布 785 个版本,首次发布于 2022/09/23;过去 12 个月发布了 16 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
3.0.0latest2026/07/223 个月前
2.1.0-rc2next2026/03/247 个月前
2.1.0-rc12026/03/148 个月前
2.0.12026/03/108 个月前
2.0.02026/02/059 个月前
2.0.0-rc32026/01/1310 个月前

关于 @frequency-chain/api-augment 的常见问题

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