# @aspnet/signalr 中文文档

规范地址：https://npmcn.com/package/%40aspnet/signalr/

版本：1\.0\.27
npm 元数据更新时间：2022-06-12T14:49:20.762Z
中文译文更新时间：2026-11-06T23:58:57.759Z
软件包许可：Apache-2\.0

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

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

弃用说明：This package is no longer supported\. Consider using @microsoft/signalr\.

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

- 包体积（解压后）：1.2 MB，139 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2018-02-27T18:25:32.199Z
- 最新版本发布：2021-04-08T16:28:06.720Z
- 近 30 天下载量：112050（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 0 个）

## 中文简介

ASP.NET 核心信号客户端

## 安装

```sh
npm install @aspnet/signalr
```

也可以使用：`pnpm add @aspnet/signalr`、`yarn add @aspnet/signalr`、`bun add @aspnet/signalr`

## README

JavaScript 和 TypeScript 客户端为 ASP. NET Core 的信号R

> : 警告: 此套件将从2021年8月21日起不再被支持. 此套件跟随 [2.1 核心支持生命周期](https://dotnet.microsoft.com/platform/support/policy/dotnet-core) 即将结束 请向使用过渡 [@ 微软/信号器](https://www.npmjs.com/package/@microsoft/signalr) 如下文所述.

> 注:用于ASP.NET信号的JavaScript和TypeScript客户端 核心已经移到 [@ 微软/信号器](https://www.npmjs.com/package/@microsoft/signalr)。如果您已经在使用 `@aspnet/signalr` 并不确定何时移动到 `@microsoft/signalr`检查 [特征分布](https://docs.microsoft.com/en-us/aspnet/core/signalr/client-features) aSP.NET核心信号R文档中的图表。 较新的客户端发布与更古老的版本的ASP.NET Core SignalR相兼容,这意味着在升级服务器之前可以安全地升级客户端.

## 安装

```bash
npm install @aspnet/signalr
```

## 使用量

见 [信号R 文档](https://docs.microsoft.com/en-us/aspnet/core/signalr) 在docs.microsoft.com提供最新发行的文档.

### 浏览器

要在浏览器中使用客户端, 请复制 `*.js` 来自 `dist/browser` 使用 `<script>` 标签.

### 节点.js

在Node.js应用程序中使用客户端需要下列多填充:

-   `XmlHttpRequest` - 总是
-   `WebSockets` - 使用WebSockets运输工具
-   `EventSource` - 使用服务器SentEvents传输
-   `btoa/atob` - 在文本传输(ServerSentEvents)上使用二进制协议(例如MessagePack)

### 示例(浏览器)

```JavaScript
let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chat")
    .build();

connection.on("send", data => {
    console.log(data);
});

connection.start()
    .then(() => connection.invoke("send", "Hello"));
```

### 示例(节点JS)

```JavaScript
const signalR = require("@aspnet/signalr");

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chat")
    .build();

connection.on("send", data => {
    console.log(data);
});

connection.start()
    .then(() => connection.invoke("send", "Hello"));
```

## 常见问题

### @aspnet/signalr 是什么？

ASP\.NET 核心信号客户端注意：该包已被作者标记为弃用——This package is no longer supported\. Consider using @microsoft/signalr\.

### 如何安装 @aspnet/signalr？

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

### @aspnet/signalr 支持 TypeScript 吗？

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

### @aspnet/signalr 支持 ESM 还是 CommonJS？

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

### @aspnet/signalr 可以商用吗？

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

### @aspnet/signalr 的下载量有多少？

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

### @aspnet/signalr 还在维护吗？

最新版本 1\.0\.27 发布于 2021/04/09（5 年前）；至今共发布 23 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/02/28。作者已将其标记为弃用，新项目建议寻找替代方案。