# @aersoftware/react-use-action-cable 中文文档

规范地址：https://npmcn.com/package/%40aersoftware/react-use-action-cable/

版本：1\.0\.4
npm 元数据更新时间：2023-05-31T13:48:28.029Z
中文译文更新时间：2026-11-07T04:09:13.567Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aersoftware/react-use-action-cable
原文对照：https://npmcn.com/package/%40aersoftware/react-use-action-cable/?lang=original
项目主页：https://github.com/aersoftware/react-use-action-cable#readme
源码仓库：https://github.com/aersoftware/react-use-action-cable

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

- 包体积（解压后）：22.8 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- peer 依赖：react ^17 \|\| ^18
- 首次发布：2022-02-07T14:02:21.263Z
- 最新版本发布：2023-05-31T13:48:27.879Z
- 近 30 天下载量：2056（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

在您的反应( Native) 应用程序中方便使用 Rails 动作电缆的钩

## 安装

```sh
npm install @aersoftware/react-use-action-cable
```

也可以使用：`pnpm add @aersoftware/react-use-action-cable`、`yarn add @aersoftware/react-use-action-cable`、`bun add @aersoftware/react-use-action-cable`

## README

# React 使用动作电缆

Hooks)在您的反应(Native)应用程序中使用"铁路行动电缆".

## 安装

```bash
npm install @aersoftware/react-use-action-cable --save
```

## 使用量

### 正在连接到 Websocket

要连接到 Action Cable, 请使用 ActionCable 钩, 并使用您想要连接的 URL 。 如果您想在整个应用程序中使用此动作电缆,请考虑在 [上下文](https://reactjs.org/docs/context.html)。 。 。 .

```js
import React, { useEffect } from 'react';
import { useActionCable, useChannel } from '@aersoftware/react-use-action-cable';

export default function index() {
  const { actionCable } = useActionCable('ws://localhost:3000/cable');
}
```

### 订阅频道

提供先前创建的频道钩子 `actionCable`。然后访问订阅和发送函数。 在下面的例子中,我们立即在第一个渲染时订阅频道"ChannelName".

```js
...
  const { subscribe, unsubscribe, send } = useChannel(actionCable)

  useEffect(() => {
    subscribe({
      channel: 'ChannelName',
      param2: '...',
      param3: '...'
    }, {
      received: (data) => console.log(data),
      // Custom callbacks can be added for 'initialized', 'connected', and 'disconnected' 
    })
    return () => {
      unsubscribe()
    }
  }, [])
...
```

### 发送数据

要将数据发送到我们所订阅的频道,我们可以使用 `send` 函数如下.

```js
send({
  action: 'ping',
  payload: {}, // Optional
  useQueue: true // Optional, default: false
})
```

在设置使用队列时 `true` 信件将被添加到队列中并尽快发送。 就是说,当网锁连接起来的时候 如果当时的websocket没有连接 `send()` 一旦网络再次连接,将立即发送.

## 常见问题

### @aersoftware/react-use-action-cable 是什么？

在您的反应\( Native\) 应用程序中方便使用 Rails 动作电缆的钩

### 如何安装 @aersoftware/react-use-action-cable？

在项目目录运行 npm install @aersoftware/react-use-action-cable，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^17 \|\| ^18）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aersoftware/react-use-action-cable 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/aersoftware\_\_react-use-action-cable 是否存在。

### @aersoftware/react-use-action-cable 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aersoftware/react-use-action-cable 可以商用吗？

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

### @aersoftware/react-use-action-cable 的下载量有多少？

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

### @aersoftware/react-use-action-cable 还在维护吗？

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