# @ceramicnetwork/rpc-postmessage 中文文档

规范地址：https://npmcn.com/package/%40ceramicnetwork/rpc-postmessage/

版本：0\.6\.1
npm 元数据更新时间：2026-10-23T10:34:33.966Z
中文译文更新时间：2026-11-09T17:08:12.412Z
软件包许可：\(Apache-2\.0 OR MIT\)

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

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

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

- 包体积（解压后）：13.3 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.14
- 运行依赖：5 个
- 首次发布：2021-03-08T14:38:02.781Z
- 最新版本发布：2022-03-25T10:43:03.726Z
- 近 30 天下载量：2200（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

[RPC 公用事业](https://github.com/ceramicnetwork/js-rpc-utils#rpc-utils) 使用 [邮件](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)

## 安装

```sh
npm install @ceramicnetwork/rpc-postmessage
```

也可以使用：`pnpm add @ceramicnetwork/rpc-postmessage`、`yarn add @ceramicnetwork/rpc-postmessage`、`bun add @ceramicnetwork/rpc-postmessage`

## README

# 后Message RPC 软件

[RPC 公用事业](https://github.com/ceramicnetwork/js-rpc-utils#rpc-utils) 使用 [邮件](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)

## 安装

```sh
npm install @ceramicnetwork/rpc-postmessage
```

## 使用量

```ts
import { createNamespaceClient, createNamespaceServer } from '@ceramicnetwork/rpc-postmessage'

type Methods = {
  foo: { result: string }
}

const server = createNamespaceServer<Methods>({
  target: window, // Listens to requests on window
  namespace: 'test',
  methods: { foo: () => 'bar' },
}).subscribe()

// Sends requests and receives responses on window
const transport = createPostMessageTransport(window, window, { postMessageArguments: ['*'] })

const client = createNamespaceClient(transport, 'test')
await client.request('foo') // 'bar'

// Stop server when done
server.unsubscribe()
```

## 类型

### 请求下载

用途 [`RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods) 财务报告和审定财务报表 [`RPCRequest`](https://github.com/ceramicnetwork/js-rpc-utils#rpcrequest)

```ts
type RequestPayload<Message, Methods extends RPCMethods, K extends keyof Methods> = {
  type: 'request'
  message: Message
  request: RPCRequest<Methods, K>
}
```

### 已处理的

用途 [`RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods), (中文(简体) ), [`RPCRequest`](https://github.com/ceramicnetwork/js-rpc-utils#rpcrequest) 财务报告和审定财务报表 [`RPCResponse`](https://github.com/ceramicnetwork/js-rpc-utils#rpcresponse)

```ts
type HandledPayload<Message, Methods extends RPCMethods, K extends keyof Methods> = {
  type: 'handled'
  message: Message
  request: RPCRequest<Methods, K>
  response: RPCResponse<Methods, K> | null
}
```

### 服务器选项

用途 [`RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods), (中文(简体) ), [`HandlerMethods`](https://github.com/ceramicnetwork/js-rpc-utils#handlermethods) 财务报告和审定财务报表 [`HandlerOptions`](https://github.com/ceramicnetwork/js-rpc-utils#handleroptions)

```ts
type ServerOptions<Context, Methods extends RPCMethods> = HandlerOptions<Context, Methods> & {
  target: PostMessageTarget
  methods: HandlerMethods<Context, Methods>
}
```

### 命名空间服务器选项

```ts
type NamespaceServerOptions<
  Methods extends RPCMethods,
  Namespace extends string = string,
  Message = IncomingMessage<Wrapped<RPCRequest<Methods, keyof Methods>, Namespace>>
> = ServerOptions<Message, Methods> & {
  namespace: Namespace
  filter?: string | Array<string> | MessageFilter
}
```

### 命名空间客户端运输

```ts
type NamespaceClientTransport<
  Methods extends RPCMethods,
  Namespace extends string,
  Incoming = IncomingMessage<Wrapped<RPCResponse<Methods, keyof Methods>, Namespace>>,
  Outgoing = Wrapped<RPCRequest<Methods, keyof Methods>, Namespace>
> = TransportSubject<Incoming, Outgoing>
```

## APIs 密码

### 服务( )

接收请求并发送对所提供的答复 `target`

**类型参数**

1.  [`Methods extends RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods)

**参数**

1.  [`options: ServerOptions<null, Methods>`](https://npmcn.com/package/%40ceramicnetwork/rpc-postmessage/#readme-serveroptions)

**回返** [`Subscription`](https://rxjs.dev/api/index/class/Subscription)

### 创建Name 空间请求汉德勒操作器( )

**类型参数**

1.  [`Methods extends RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods)
2.  `Namespace extends string = string`
3.  `Message = IncomingMessage<Wrapped<RPCRequest<Methods, keyof Methods>, Namespace>>`

**参数**

1.  `methods: HandlerMethods<Message, Methods>`
2.  `namespace: Namespace`
3.  `options?: HandlerOptions<Message, Methods> = {}`

**回返** `OperatorFunction<Message, HandledPayload<Message, Methods, keyof Methods>>`

### 创建Name spaceServer ()

**类型参数**

1.  [`Methods extends RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods)
2.  `Namespace extends string = string`
3.  `Request = Wrapped<RPCRequest<Methods, keyof Methods>, Namespace>`

**参数**

1.  [`options: NamespaceServerOptions<Methods, Namespace, IncomingMessage<Request>>`](https://npmcn.com/package/%40ceramicnetwork/rpc-postmessage/#readme-namespaceserveroptions)

**回返** `Observable<HandledPayload<IncomingMessage<Request>, Methods, keyof Methods>>`

### 创建Name 空间发送请求 ()

**类型参数**

1.  [`Methods extends RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods)
2.  `Namespace extends string = string`

**参数**

1.  [`transport: NamespaceClientTransport<Methods, Namespace>`](https://npmcn.com/package/%40ceramicnetwork/rpc-postmessage/#readme-namespaceclienttransport)
2.  `namespace: Namespace`
3.  `options?: UnwrapObservableOptions`

**回返** [`SendRequestFunc<Methods>`](https://github.com/ceramicnetwork/js-rpc-utils#sendrequestfunc)

### 创建“ 空间密度 ”

**类型参数**

1.  [`Methods extends RPCMethods`](https://github.com/ceramicnetwork/js-rpc-utils#rpcmethods)
2.  `Namespace extends string = string`

**参数**

1.  [`transport: NamespaceClientTransport<Methods, Namespace>`](https://npmcn.com/package/%40ceramicnetwork/rpc-postmessage/#readme-namespaceclienttransport)
2.  `namespace: Namespace`
3.  `options?: UnwrapObservableOptions`

**回返** [`RPCClient<Methods>`](https://github.com/ceramicnetwork/js-rpc-utils#rpcclient-class)

## 许可证

Apache-2.0或麻省理工学院

## 常见问题

### @ceramicnetwork/rpc-postmessage 是什么？

RPC 公用事业 使用 邮件

### 如何安装 @ceramicnetwork/rpc-postmessage？

在项目目录运行 npm install @ceramicnetwork/rpc-postmessage，或使用 pnpm add / yarn add / bun add。

### @ceramicnetwork/rpc-postmessage 支持 TypeScript 吗？

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

### @ceramicnetwork/rpc-postmessage 支持 ESM 还是 CommonJS？

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

### @ceramicnetwork/rpc-postmessage 需要什么版本的 Node\.js？

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

### @ceramicnetwork/rpc-postmessage 可以商用吗？

@ceramicnetwork/rpc-postmessage 使用 \(Apache-2\.0 OR MIT\) 许可。可在 Apache-2\.0、MIT 中任选其一遵守。选择 Apache-2\.0 时，宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @ceramicnetwork/rpc-postmessage 的下载量有多少？

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

### @ceramicnetwork/rpc-postmessage 还在维护吗？

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