# @giantmachines/redux-websocket 中文文档

规范地址：https://npmcn.com/package/%40giantmachines/redux-websocket/

版本：1\.5\.1
npm 元数据更新时间：2023-10-05T15:33:09.606Z
中文译文更新时间：2026-11-16T08:23:16.654Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：51.5 kB，11 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2016-11-22T16:25:35.189Z
- 最新版本发布：2021-05-10T19:54:29.610Z
- 近 30 天下载量：10833（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 0 个）

## 中文简介

用于处理 Websocket 连接的 redux 中间软件

## 安装

```sh
npm install @giantmachines/redux-websocket
```

也可以使用：`pnpm add @giantmachines/redux-websocket`、`yarn add @giantmachines/redux-websocket`、`bun add @giantmachines/redux-websocket`

## README

# 红外网 [![codecov](https://codecov.io/gh/giantmachines/redux-websocket/branch/master/graph/badge.svg)](https://codecov.io/gh/giantmachines/redux-websocket) [![npm version](https://badge.fury.io/js/%40giantmachines%2Fredux-websocket.svg)](https://badge.fury.io/js/%40giantmachines%2Fredux-websocket) ![npm](https://img.shields.io/npm/dm/@giantmachines/redux-websocket)

> ⚠️⚠️⚠️ **注: 该项目将进入可预见未来的维护模式,以便我们能够专注于其他内部举措。 我们感谢你利用我们的图书馆,希望它对你有用! 请随意叉出一个版本的 redux-websocket, 如果您想扩展它, 或运行到任何需要大修改的重要问题或错误 。 最后一个稳定版本是 `v1.5.1`**。 。 。 .

`redux-websocket` 用于通过 WebSocket 连接管理数据的 Redux 中间软件.

这个中间软件使用动作与一个WebSocket连接交互,包括连接,断开,发送消息,以及接收消息. 所有行动都遵循 [奢侈标准动作](https://github.com/acdlite/flux-standard-action) 型号.

### 特征

-   在 TypeScript 中写入 .
-   通过发送动作与 WebSocket 连接进行交互.
-   通过创建多个中间软件实例来连接多个WebSocket流.
-   以 Redux 中间软件处理 WebSocket 事件,与 Saga 集成,并使用还原器来持久状态.
-   自动处理再连接 .

## 安装

```sh
$ npm i @giantmachines/redux-websocket
```

## 配置

配置您的 Redux 商店以使用中间软件 `applyMiddleware`。此软件包导出一个函数来创建中间软件实例,允许配置选项,详情如下。 此外,您可以创建此中间软件的多例,以便连接多个WebSocket流.

```js
import { applyMiddleware, compose, createStore } from 'redux';
import reduxWebsocket from '@giantmachines/redux-websocket';

import reducer from './store/reducer';

// Create the middleware instance.
const reduxWebsocketMiddleware = reduxWebsocket();

// Create the Redux store.
const store = createStore(reducer, applyMiddleware(reduxWebsocketMiddleware));
```

您也可以向 `reduxWebsocket` 函数.

#### 可用选项

```js
interface Options {
  // Defaults to 'REDUX_WEBSOCKET'. Use this option to set a custom action type
  // prefix. This is useful when you're creating multiple instances of the
  // middleware, and need to handle actions dispatched by each middleware instance separately.
  prefix?: string;
  // Defaults to 2000. Amount of time to wait between reconnection attempts.
  reconnectInterval?: number;
  // Defaults to false. If set to true, will attempt to reconnect when conn is closed without error event
  // e.g. when server closes connection
  reconnectOnClose?: boolean;
  // Defaults to true. If set to true, will attempt to reconnect when conn is closed with error event
  reconnectOnError?: boolean;
  // Callback when the WebSocket connection is open. Useful for when you
  // need a reference to the WebSocket instance.
  onOpen?: (socket: WebSocket) => void;
  // Custom function to serialize your payload before sending. Defaults to JSON.stringify
  // but you could use this function to send any format you like, including binary
  serializer?: (payload: any) => string | ArrayBuffer | ArrayBufferView | Blob;
  // Custom function to deserialize the message data sent from the server. By default the
  // message data gets passed through as is.
  deserializer?: (message: any) => any;
  // Custom function to serialize the timestamp. The default behavior maintains the timestamp
  // as a Date but you could use this function to store it as a string or number.
  dateSerializer?: (date: Date) => string | number;
}
```

## 使用量

`redux-websocket` 根据WebSocket的内部连接, 将自动发送一些动作 。 有些行动需要你发出.

默认 `redux-websocket` 以时间戳作为 `Date` 对象。 这导致一些用户在使用redux工具包时会经历非序列动作警告. 如果你遇到这个问题,可以添加一个 `dateSerializer` 函数改为 `redux-websocket` 选项或 [设置 redux 工具包](https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data) 无视行动.

### 用户发送动作

这些动作必须由您发出, 但是,我们做输出动作创建功能 可以使用.

> 如果你用一个 `prefix` 选项,请确保将前缀作为第二个参数传递给所有这些动作创建者.

* * *

##### ➡️ `REDUX_WEBSOCKET::WEBSOCKET_CONNECT`

###### 示例

```js
import { connect } from '@giantmachines/redux-websocket';

store.dispatch(connect('wss://my-server.com'));

// You can also provide protocols if needed.
// See: https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket
//
// Note that this function only allows passing an array of protocols, even though
// the spec allows passing a string or an array of strings. This is to support
// the prefix argument, in the case that you've prefixed your action names.
store.dispatch(connect('wss://my-server.com', ['v1.stream.example.com']));

// ...other ways to call this function:
store.dispatch(
  connect('wss://my-server.com', ['v1.stream.example.com'], 'MY_PREFIX')
);
store.dispatch(connect('wss://my-server.com', 'MY_PREFIX'));
```

###### 参数 :

1.  `url` _(单位:千美元)`string`(中文(简体) )_: 要连接的 WebSocket URL.
2.  \[`protocols`\[ . \] _(单位:千美元)`string[]`(中文(简体) )_:可选子议定书.
3.  \[`prefix`\[ . \] _(单位:千美元)`string`(中文(简体) )_: 可选动作类型前缀.

* * *

##### ➡️ `REDUX_WEBSOCKET::WEBSOCKET_DISCONNECT`

###### 示例

```js
import { disconnect } from '@giantmachines/redux-websocket';

store.dispatch(disconnect());
```

###### 参数 :

1.  \[`prefix`\[ . \] _(单位:千美元)`string`(中文(简体) )_: 可选动作类型前缀.

* * *

##### ➡️ `REDUX_WEBSOCKET::WEBSOCKET_SEND`

###### 示例

```js
import { send } from '@giantmachines/redux-websocket';

store.dispatch(send({ my: 'message' }));
```

###### 参数 :

1.  `message` _(单位:千美元)`any`(中文(简体) )_任何JSON的可序列值。 这将被字符串化并发送到连接上 。 如果传递的值不能序列化, `JSON.stringify` 将投出一个错误.
2.  \[`prefix`\[ . \] _(单位:千美元)`string`(中文(简体) )_: 可选动作类型前缀.

* * *

### 图书馆发出行动

这些动作由中继器自动发送.

##### ⬅️ `REDUX_WEBSOCKET::OPEN`

当WebSocket连接成功打开时,包括自动重接后,便被调出.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::OPEN',
    meta: {
        timestamp: Date,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::CLOSED`

当WebSocket连接成功关闭时,无论是在您要求中间软件关闭连接时,还是在连接下降时,都会被发送.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::CLOSED',
    meta: {
        timestamp: Date,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::MESSAGE`

当WebSocket连接收到消息时发送. 该有效载荷包括: `message` 键,这是 JSON,以及 `origin` 键,这是消息被调回的连接地址.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::MESSAGE',
    meta: {
        timestamp: Date,
    },
    payload: {
        message: string,
        origin: string,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::BROKEN`

放弃 WebSocket 连接时已发送 。 行动将永远发出 _之后_ 页:1 `CLOSED` 行动.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::BROKEN',
    meta: {
        timestamp: Date,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::BEGIN_RECONNECT`

当中间器件开始重联进程时被发送.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::BEGIN_RECONNECT',
    meta: {
        timestamp: Date,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::RECONNECT_ATTEMPT`

每次中间软件尝试重新连接时 都会被调出 包括a `count` 作为有效载荷的一部分.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::RECONNECT_ATTEMPT',
    meta: {
        timestamp: Date,
    },
    payload: {
        count: number,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::RECONNECTED`

中间软件重新连接时发送. 这个动作在开始之前就被删除了 `OPEN` 行动.

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::RECONNECTED',
    meta: {
        timestamp: Date,
    },
}
```

* * *

##### ⬅️ `REDUX_WEBSOCKET::ERROR`

通用错误动作 .

###### 结构

```js
{
    type: 'REDUX_WEBSOCKET::ERROR',
    error: true,
    meta: {
        timestamp: Date,
        message: string,
        name: string,
        originalAction: Action | null,
    },
    payload: Error,
}
```

## 常见问题

### @giantmachines/redux-websocket 是什么？

用于处理 Websocket 连接的 redux 中间软件

### 如何安装 @giantmachines/redux-websocket？

在项目目录运行 npm install @giantmachines/redux-websocket，或使用 pnpm add / yarn add / bun add。

### @giantmachines/redux-websocket 支持 TypeScript 吗？

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

### @giantmachines/redux-websocket 支持 ESM 还是 CommonJS？

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

### @giantmachines/redux-websocket 可以商用吗？

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

### @giantmachines/redux-websocket 的下载量有多少？

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

### @giantmachines/redux-websocket 还在维护吗？

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

