@giantmachines/redux-websocket

中文文档
1.5.1发布于 2021/05/11MITCommonJS近 30 天下载 1.1万

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

中文使用文档
文档目录6 节
  1. 特征
  2. 安装
  3. 配置
  4. 使用量
  5. 用户发送动作
  6. 图书馆发出行动

红外网 codecov npm version npm

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

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

这个中间软件使用动作与一个WebSocket连接交互,包括连接,断开,发送消息,以及接收消息. 所有行动都遵循 奢侈标准动作 型号.

特征

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

安装

$ npm i @giantmachines/redux-websocket

配置

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

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 函数.

可用选项

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 工具包 无视行动.

用户发送动作

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

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


➡️ REDUX_WEBSOCKET::WEBSOCKET_CONNECT
示例
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
示例
import { disconnect } from '@giantmachines/redux-websocket';

store.dispatch(disconnect());
参数 :
  1. [prefix[ . ] (单位:千美元)string(中文(简体) ): 可选动作类型前缀.

➡️ REDUX_WEBSOCKET::WEBSOCKET_SEND
示例
import { send } from '@giantmachines/redux-websocket';

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

图书馆发出行动

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

⬅️ REDUX_WEBSOCKET::OPEN

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

结构
{
    type: 'REDUX_WEBSOCKET::OPEN',
    meta: {
        timestamp: Date,
    },
}

⬅️ REDUX_WEBSOCKET::CLOSED

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

结构
{
    type: 'REDUX_WEBSOCKET::CLOSED',
    meta: {
        timestamp: Date,
    },
}

⬅️ REDUX_WEBSOCKET::MESSAGE

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

结构
{
    type: 'REDUX_WEBSOCKET::MESSAGE',
    meta: {
        timestamp: Date,
    },
    payload: {
        message: string,
        origin: string,
    },
}

⬅️ REDUX_WEBSOCKET::BROKEN

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

结构
{
    type: 'REDUX_WEBSOCKET::BROKEN',
    meta: {
        timestamp: Date,
    },
}

⬅️ REDUX_WEBSOCKET::BEGIN_RECONNECT

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

结构
{
    type: 'REDUX_WEBSOCKET::BEGIN_RECONNECT',
    meta: {
        timestamp: Date,
    },
}

⬅️ REDUX_WEBSOCKET::RECONNECT_ATTEMPT

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

结构
{
    type: 'REDUX_WEBSOCKET::RECONNECT_ATTEMPT',
    meta: {
        timestamp: Date,
    },
    payload: {
        count: number,
    },
}

⬅️ REDUX_WEBSOCKET::RECONNECTED

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

结构
{
    type: 'REDUX_WEBSOCKET::RECONNECTED',
    meta: {
        timestamp: Date,
    },
}

⬅️ REDUX_WEBSOCKET::ERROR

通用错误动作 .

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

版本与发布记录

@giantmachines/redux-websocket 共发布 48 个版本,首次发布于 2016/11/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.1latest2021/05/115 年前
1.5.02021/02/175 年前
1.4.02020/11/185 年前
1.3.02020/09/306 年前
1.2.32020/08/126 年前
1.2.22020/07/086 年前

其他发布通道:next → 1.0.0-alpha.3。

关于 @giantmachines/redux-websocket 的常见问题

@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 和提交记录判断。