@blockprotocol/service

中文文档
0.1.5发布于 2024/03/19MITTypeScriptES Module近 30 天下载 2.3万

实施区块议定书服务模块规格和嵌入应用

中文使用文档
文档目录6 节
  1. 区块协议-服务单元
  2. 块
  3. 反应示例
  4. 自定义元素
  5. 嵌入应用程序
  6. 反应

区块协议-服务单元

这个软件包为块和嵌入应用程序执行块协议服务模块.

要开始 :

  1. yarn add @blockprotocol/service 或者说 npm install @blockprotocol/service
  2. 遵循使用服务模块作为工具的指令 块 或一个 嵌入应用程序

块

创建 ServiceBlockHandler中,将构造器传递到您块中的元素,以及您想要注册的用于处理来信的任何调用.

反应示例

对于反应,我们提供 useServiceBlockModule 钩子,它接受 ref 对一个元素,可选择任意 callbacks 您希望提供初始化服务.

自定义元素

创建一个 ServiceBlockHandler 在你体内。 如果您正在使用我们的模板, 您可以在构建的 Callback 实例法中添加此内容(公升文件),并可供您元素使用.

  ...
  connectedCallback() {
    super.connectedCallback();
    if (!this.serviceModule || this.serviceModule.destroyed) {
      this.serviceModule = new ServiceBlockHandler({
        element: this,
      });
    }
  }

  retrieveDirections(data) {
    if (!this.serviceModule) {
      throw new Error("Service module not available");
    }
    this.serviceModule.mapboxRetrieveDirections(args).then(() => { ... });
  }

  ...

嵌入应用程序

你应该建造一个 ServiceEmbedderHandler 每块.

目前无法用单一的处理器来包裹多个块.

创建 ServiceEmbedderHandler,通过构造器:

  1. 一个 element 包装您的块
  2. callbacks 以响应块中的信息
import { ServiceEmbedderHandler } from "@blockprotocol/service";

const serviceModule = new ServiceEmbedderHandler({
  callbacks: { ... },
  element: elementWrappingTheBlock,
});

反应

对于反应嵌入应用程序,我们提供一个 useServiceEmbedderModule 钩子,它接受 ref ,以及您想要通过的任何附加构造参数.

import { useServiceEmbedderModule } from "@blockprotocol/service";
import { useRef } from "react";

export const App = () => {
  const wrappingRef = useRef<HTMLDivElement>(null);

  const { serviceModule } = useServiceEmbedderModule(blockRef);

  return (
    <div ref={wrappingRef}>
      <Block />
    </div>
  );
};

版本与发布记录

@blockprotocol/service 共发布 34 个版本,首次发布于 2023/02/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.5latest2024/03/192 年前
0.1.5-canary-20240314113521canary2024/03/142 年前
0.1.5-canary-202403131225332024/03/132 年前
0.1.5-canary-202403121912272024/03/132 年前
0.1.5-canary-202403041547262024/03/042 年前
0.1.5-canary-202403041425212024/03/042 年前

关于 @blockprotocol/service 的常见问题

@blockprotocol/service 是什么?

实施区块议定书服务模块规格和嵌入应用

如何安装 @blockprotocol/service?

在项目目录运行 npm install @blockprotocol/service,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@blockprotocol/service 支持 TypeScript 吗?

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

@blockprotocol/service 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@blockprotocol/service 可以商用吗?

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

@blockprotocol/service 的下载量有多少?

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

@blockprotocol/service 还在维护吗?

最新版本 0.1.5 发布于 2024/03/19(2 年前);至今共发布 34 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/02/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。