# @cactuslab/usepubsub 中文文档

规范地址：https://npmcn.com/package/%40cactuslab/usepubsub/

版本：1\.0\.2
npm 元数据更新时间：2022-04-04T21:28:42.457Z
中文译文更新时间：2026-11-08T23:14:13.675Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.3 MB，19 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=8
- 运行依赖：0 个
- peer 依赖：react ^16\.9\.0
- 首次发布：2021-02-03T05:15:30.649Z
- 最新版本发布：2021-02-03T20:17:30.630Z
- 近 30 天下载量：5336（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

> 将 Publish 和订阅添加到 React 应用程序的响应钩 .

## 安装

```sh
npm install @cactuslab/usepubsub
```

也可以使用：`pnpm add @cactuslab/usepubsub`、`yarn add @cactuslab/usepubsub`、`bun add @cactuslab/usepubsub`

## README

# 使用 PubSub

> 将 Publish 和订阅添加到 React 应用程序的响应钩 .

[![NPM](https://img.shields.io/npm/v/@cactuslab/usepubsub.svg)](https://www.npmjs.com/package/@cactuslab/usepubsub) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com/)

这个 `usePubSub` 钩子为您的 React 组件提供了访问当前 `PubSubContext`打开 你可以做到这一点 `publish` 给频道留言,以及 `subscribe` 到频道接收消息.

你提供 `PubSubContext` 使用 `<PubSubProvider>` 在应用程序的根层(或任何地方).

您也可以明确创建 `PubSubContext` 使用 `createPubSubContext()` 并提供给: `<PubSubProvider context={myContext}>`,然后使用 `publish`, (中文(简体) ), `subscribe` 财务报告和审定财务报表 `unsubscribe` 工作方法 `PubSubContext` 你申请的任何地方.

## 安装

```shell
npm install --save @cactuslab/usepubsub
```

## 使用量

```tsx
import * as React from 'react'

import { usePubSub, PubSubProvider } from '@cactuslab/usepubsub'

/* Add a top-level PubSubProvider to your app to initialise the PubSub context */
const App = () => {
   return (
    <PubSubProvider>
      ...
    </PubSubProvider>
  )
}

const ExampleSubscriber = () => {
  const { subscribe } = usePubSub()
  React.useEffect(function() {
    return subscribe('CHANNEL', function(message) {
      ...
    })
  })
}

const ExamplePublisher = () => {
  const { publish } = usePubSub()
  
  function sendMessage() {
    publish('CHANNEL', nextMessage)
  }
}
```

### 提供自定义上下文

使用 `createPubSubContext()` 创建 `PubSubContext`,然后调用 `publish`, (中文(简体) ), `subscribe` 财务报告和审定财务报表 `unsubscribe` 在你的申请的任何地方.

```tsx
import { createPubSubContext, PubSubProvider } from '@cactuslab/usepubsub'

const myContext = createPubSubContext()

myContext.subscribe('ALERT_CHANNEL', function(message) {
  alert(message)
})

const App = () => {
  return (
    <PubSubProvider context={myContext}>
      ...
    </PubSubProvider>
  )
}
```

## API 参考

```tsx
type Handler = (message: unknown) => void

interface PubSubContext {
  publish: (channel: string, message: unknown) => void
  subscribe: (channel: string, handler: Handler) => () => void
  unsubscribe: (channel: string, handler: Handler) => void
}

/* Functions */
function createPubSubContext(): PubSubContext

/* Hooks */
function usePubSub(): PubSubContext

/* Components */
<PubSubProvider />
<PubSubProvider context={PubSubContext} />
```

## 许可证

麻省理工学院 [仙人掌](https://github.com/cactuslab)

* * *

此钩是使用 [创建- 反应- hook](https://github.com/hermanya/create-react-hook)。 。 。 .

## 常见问题

### @cactuslab/usepubsub 是什么？

将 Publish 和订阅添加到 React 应用程序的响应钩 \.

### 如何安装 @cactuslab/usepubsub？

在项目目录运行 npm install @cactuslab/usepubsub，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cactuslab/usepubsub 支持 TypeScript 吗？

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

### @cactuslab/usepubsub 支持 ESM 还是 CommonJS？

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

### @cactuslab/usepubsub 需要什么版本的 Node\.js？

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

### @cactuslab/usepubsub 可以商用吗？

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

### @cactuslab/usepubsub 的下载量有多少？

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

### @cactuslab/usepubsub 还在维护吗？

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