@harelpls/use-pusher
- 安装
- 钩子
- 使用量
useChannelusePresenceChanneluseEventuseTriggerusePusher- 触发服务器
useClientTrigger- 字体
- 测试
- 原生反应
- 捐款
- 许可证
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";
捐款
- 清除仓库并运行
yarn && yarn test:watch - 编码!
请写测试( 100% 的覆盖) 和类型 .
许可证
麻省理工学院 @ mayteio (英语)
此钩是使用 创建- 反应- hook。 。 。 .