# @cspell/rpc 中文文档

规范地址：https://npmcn.com/package/%40cspell/rpc/

版本：10\.4\.1
npm 元数据更新时间：2026-11-06T17:19:52.956Z
中文译文更新时间：2026-11-11T03:14:45.007Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cspell/rpc
原文对照：https://npmcn.com/package/%40cspell/rpc/?lang=original
项目主页：https://github.com/streetsidesoftware/cspell/tree/main/packages/rpc#readme
源码仓库：https://github.com/streetsidesoftware/cspell

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

- 包体积（解压后）：48.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：0 个
- 首次发布：2026-02-02T18:26:23.644Z
- 最新版本发布：2026-11-06T17:19:52.611Z
- 近 30 天下载量：5651217（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

类型安全 RPC 库.

## 安装

```sh
npm install @cspell/rpc
```

也可以使用：`pnpm add @cspell/rpc`、`yarn add @cspell/rpc`、`bun add @cspell/rpc`

## README

# 简单的 RPC

一个基本的客户端 / 服务器 RPC, 用于通过 MessagePort 发送请求 .

这支持节点工人线索,Web Workers,或者任何可以提供MessagePortLike接口的东西.

## 通讯详情

客户端和服务器通过 MessagePort 发送消息进行通信.

```ts
export interface RPCMessage {
  sig: 'RPC0';
  /**
   * A Unique identifier for the request/response.
   * Ideally this is a randomUUID.
   */
  id: RequestID;
  /**
   * The type of message being sent.
   */
  type: 'request' | 'response' | 'cancel' | 'canceled' | 'ok' | 'ready';
}

export type RPCRequestType = 'request' | 'cancel' | 'ok' | 'ready';

export type RPCResponseType = 'response' | 'canceled' | 'ok' | 'ready';
```

信息有两种类型:请求和回应. 客户端发送请求而服务器发送回复.

### RPC 请求

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>
    S->>+W: Method
    W->>-S: Result
    S->>-C: Response <id>, Result
```

### RPC 请求使用ACK

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>, ACK
    S->>C: ACK <id>
    S->>+W: Method
    W->>-S: Result
    S->>-C: Response <id>, Result
```

### RPC 请求出错

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>, ACK
    S->>C: ACK <id>
    S->>+W: Method
    W->>-S: Error
    S->>-C: Response <id>, Error
```

### 确定请求

此请求用于检查服务器是否正常 .

```mermaid
sequenceDiagram
    Client->>Server: OK <id>?
    Server->>Client: OK <id>, Code 200
```

### 取消请求

取消请求用于取消或中止请求。 服务器接受请求并承认收到请求. 根据模式的不同,服务器要么立即响应而不等待工人确认取消,要么在回复前等待确认:

#### 取消请求: 不等待

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>
    S->>+W: Method
    C->>S: Cancel <id>
    S->>-C: Canceled <id>
    S--xW: Cancel
    W--x-S: Canceled
```

#### 取消请求: 等待

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>
    S->>+W: Method
    C->>S: Cancel <id>, Wait
    S--xW: Cancel
    W-->>-S: Canceled
    S->>-C: Canceled <id>
```

### RPC 请求, 由服务器取消

可能会发生服务器需要取消请求的情况. 如果服务器正在处理中, 并且仍有待处理的请求, 可能会发生这种情况 。 它有几种方法可以做到这一点:

1.  发送错误反应
2.  发送已取消的答复

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    participant W as Worker
    C->>+S: Request <id>
    S->>+W: Method
    W--x-S: Canceled
    S->>-C: Canceled <id>
```

### 中止

中止请求与取消请求相同,只有客户端不会等待响应,响应会被忽略.

```mermaid
sequenceDiagram
    participant C as Client
    participant S as Server
    C->>S: Request <id>
    C-->>S: Cancel <id>
    S--xC: Canceled <id>
```

## 常见问题

### @cspell/rpc 是什么？

类型安全 RPC 库\.

### 如何安装 @cspell/rpc？

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

### @cspell/rpc 支持 TypeScript 吗？

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

### @cspell/rpc 支持 ESM 还是 CommonJS？

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

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

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

### @cspell/rpc 可以商用吗？

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

### @cspell/rpc 的下载量有多少？

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

### @cspell/rpc 还在维护吗？

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