@harelpls/use-pusher

中文文档
7.2.1发布于 2021/03/02MITTypeScriptESM + CJS近 30 天下载 9万

在React中用包子来装方便的钩子.

中文使用文档
文档目录16 节
  1. API 参考文献/文档
  2. 安装
  3. 钩子
  4. 使用量
  5. useChannel
  6. usePresenceChannel
  7. useEvent
  8. useTrigger
  9. usePusher
  10. 触发服务器
  11. useClientTrigger
  12. 字体
  13. 测试
  14. 原生反应
  15. 捐款
  16. 许可证

@harelpls/use-pusher

很简单 反应钩 与 pusher-js 图书馆.

NPM Typed

API 参考文献/文档

安装

yarn add @harelpls/use-pusher

钩子

使用量

你必须用一个包装你的应用程序 PusherProvider 并通过它配置道具 pusher-js 初始化 .

import React from "react";
import { PusherProvider } from "@harelpls/use-pusher";

const config = {
  // required config props
  clientKey: "client-key",
  cluster: "ap4",

  // optional if you'd like to trigger events. BYO endpoint.
  // see "Trigger Server" below for more info
  triggerEndpoint: "/pusher/trigger",

  // required for private/presence channels
  // also sends auth headers to trigger endpoint
  authEndpoint: "/pusher/auth",
  auth: {
    headers: { Authorization: "Bearer token" },
  },
};

// Wrap app in provider
const App = () => {
  <PusherProvider {...config}>
    <Example />
  </PusherProvider>;
};

useChannel

使用此钩子订阅频道 .

// returns channel instance.
const channel = useChannel("channel-name");

usePresenceChannel

增强具有成员功能的正则频道.

const Example = () => {
  const { members, myID } = usePresenceChannel('presence-awesome');

  return (
    <ul>
      {Object.entries(members)
        // filter self from members
        .filter(([id]) => id !== myID)
        // map them to a list
        .map(([id, info]) => (
          <li key={id}>{info.name}</li>
        ))
      }
    </ul>
  )
}

useEvent

与频道上的事件捆绑,并带有回调.

const Example = () => {
  const [message, setMessages] = useState();
  const channel = useChannel("channel-name");
  useEvent(channel, "message", ({ data }) =>
    setMessages((messages) => [...messages, data])
  );
};

说明: 这将绑定和解除每次渲染上的事件 。 你也许想记住你的回电 useCallback 如果你注意到性能问题,就先送进去.

useTrigger

创建一个 服务器已触发 活动。 BYO 服务器( 见 触发服务器 页:1 通过进来 triggerEndpoint 向 <PusherProvider />。任何来自 config.auth.headers 自动传递到 fetch 电话.

import { useTrigger } from '@harelpls/use-pusher';

const Example = () => {.
  const trigger = useTrigger("channel-name");
  const handleClick = () =>
    trigger("event-name", "hello");

  return (
    <button onClick={handleClick}>Say Hello</button>
  )
}

usePusher

获取 Pusher 实例 做其他事情.

import { usePusher } from "@harelpls/use-pusher";

const Example = () => {
  const { client } = usePusher();
  client.log("Look ma, logs!");

  return null;
};

触发服务器

为了触发一个事件,你必须创建一个简单的Lambda(或快递服务器,如果这是你的事情). 下面是一个简短的Lambda,可以处理触发的事件来自 useTrigger。 。 。 .

import Pusher from "pusher";

const pusher = new Pusher({
  appId: "app-id",
  key: "client-key",
  secret: "mad-secret",
  cluster: "ap4",
});

export async function handler(event) {
  const { channelName, eventName, data } = JSON.parse(event.body);
  pusher.trigger(channelName, eventName, data);
  return { statusCode: 200 };
}

useClientTrigger

不过我不想要服务器

我听见了 如果你觉得大胆,你可以使用 客户端事件 从客户端直接推出 :

import { useChannel, useClientTrigger } from "@harelpls/use-pusher";

const Example = () => {
  const channel = useChannel("presence-ca");
  const trigger = useClientTrigger(channel);
  const handleClientEvent = () => {
    trigger("Pew pew");
  };

  return <button onClick={handleClientEvent}>Fire</button>;
};

字体

这个工程是使用打字符建造的,所以类型是内置的. 哟!

测试

我和他们合作过 @ nikolalsvk 页面存档备份,存于互联网档案馆 打开 pusher-js-mock 给大家带来一个伟大的推手嘲笑.

使用 : jest.mock 财务报告和审定财务报表 @testing-library/react (或 enzyme,尽管您的测试应当反映用户应当看到的内容 没有 组件如何在内部处理事件 :

// Example.tsx
import React from "react";
import { useChannel, useEvent } from "@harelpls/use-pusher";

const Example = () => {
  const [title, setTitle] = useState();
  const channel = useChannel("my-channel");
  useEvent(channel, "title", ({ data }) => setTitle(data));

  return <span>{title}</span>;
};

// Example.test.tsx
import { render, act } from "@testing-library/react";
import { PusherMock, PusherChannelMock } from "pusher-js-mock";

// mock out the result of the useChannel hook
const mockChannel = new PusherChannelMock();
jest.mock("@harelpls/use-pusher", () => ({
  ...require.requireActual("@harelpls/use-pusher"),
  useChannel: () => mockChannel,
}));

test("should show a title when it receives a title event", async () => {
  // mock the client
  const client = new PusherMock("client-key", { cluster: "ap4" });

  // render component and provider with a mocked context value
  const { findByText } = render(
    <PusherProvider clientKey="client-key" cluster="ap4" value={{ client }}>
      <Example />
    </PusherProvider>
  );

  // emit an event on the mocked channel
  act(() => mockChannel.emit("title", { data: "Hello world" }));

  // assert expectations
  expect(await findByText("Hello world")).toBeInTheDocument();
});

检查一下示例测试 测试存在通道.

原生反应

这个软件包与React Independence的支持相伴而来. 导入您的 PusherProvider 从 @harelpls/use-pusher/react-native 而不是默认 @harelpls/use-pusher所有出口都从那里再出口.

保证您也将网络信息包添加到您的工程中 : @react-native-community/netinfo。 。 。 .

import { PusherProvider, useChannel } from "@harelpls/use-pusher/react-native";

捐款

  1. 清除仓库并运行 yarn && yarn test:watch
  2. 编码!

请写测试( 100% 的覆盖) 和类型 .

许可证

麻省理工学院 @ mayteio (英语)


此钩是使用 创建- 反应- hook。 。 。 .

版本与发布记录

@harelpls/use-pusher 共发布 29 个版本,首次发布于 2020/01/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
7.2.1latest2021/03/025 年前
7.1.02020/09/186 年前
7.0.02020/08/196 年前
6.0.32020/08/196 年前
6.0.22020/07/236 年前
6.0.12020/07/226 年前

其他发布通道:beta → 4.1.4。

关于 @harelpls/use-pusher 的常见问题

@harelpls/use-pusher 是什么?

在React中用包子来装方便的钩子.

如何安装 @harelpls/use-pusher?

在项目目录运行 npm install @harelpls/use-pusher,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^16.9.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@harelpls/use-pusher 支持 TypeScript 吗?

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

@harelpls/use-pusher 支持 ESM 还是 CommonJS?

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

@harelpls/use-pusher 需要什么版本的 Node.js?

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

@harelpls/use-pusher 可以商用吗?

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

@harelpls/use-pusher 的下载量有多少?

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

@harelpls/use-pusher 还在维护吗?

最新版本 7.2.1 发布于 2021/03/02(5 年前);至今共发布 29 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/01/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。