# @custom-react-hooks/use-effect-once 中文文档

规范地址：https://npmcn.com/package/%40custom-react-hooks/use-effect-once/

版本：1\.5\.1
npm 元数据更新时间：2024-08-18T11:19:57.612Z
中文译文更新时间：2026-11-11T05:41:00.583Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40custom-react-hooks/use-effect-once
原文对照：https://npmcn.com/package/%40custom-react-hooks/use-effect-once/?lang=original
项目主页：https://custom-react-hooks-live.vercel.app/
源码仓库：https://github.com/djkepa/custom-react-hooks

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

- 包体积（解压后）：6.9 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react \>=16
- 首次发布：2023-12-01T23:45:41.722Z
- 最新版本发布：2024-08-18T11:19:57.423Z
- 近 30 天下载量：3490（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

`useEffectOnce` 是React中的自定义钩子,旨在模仿 `componentDidMount` 财务报告和审定财务报表 `componentWillUnmount` 类组分中的生命周期方法. 这是经过修改的版本 `useEffect` 它只在组件上架时运行一次.

## 安装

```sh
npm install @custom-react-hooks/use-effect-once
```

也可以使用：`pnpm add @custom-react-hooks/use-effect-once`、`yarn add @custom-react-hooks/use-effect-once`、`bun add @custom-react-hooks/use-effect-once`

## README

# 使用效果

`useEffectOnce` 是React中的自定义钩子,旨在模仿 `componentDidMount` 财务报告和审定财务报表 `componentWillUnmount` 类组分中的生命周期方法. 这是经过修改的版本 `useEffect` 它只在组件上架时运行一次.

## 特征

-   **一次执行 :** 钩子在组件初始渲染时执行提供的效果函数一次.
-   **清理能力 :** 它支持一个可选的清除函数,从效果中返回,当组件卸载时会叫它.
-   **SSR 兼容性 :** 作为延伸 `useEffect`,它与服务器侧渲染环境自然相容.

## 安装

选择并安装适合您项目需要的单个钩子, 或安装整个收藏, 用于全套公用事业 .

### 只安装当前钩

```bash
npm install @custom-react-hooks/use-effect-once
```

或者说

```bash
yarn add @custom-react-hooks/use-effect-once
```

### 安装全部钩

```sh
npm install @custom-react-hooks/all
```

或者说

```sh
yarn add @custom-react-hooks/all
```

## 导入虎克

这个 `useEffectOnce` 钩必须使用下列命名的导入方式导入:

**已命名的导入 :**

```javascript
import { useEffectOnce } from '@custom-react-hooks/use-effect-once';
```

这种方法确保了钩子无缝地融入到您的项目中,在您如何使用我们的包时保持一致性和可预测性.

## 使用量

```typescript
import React from 'react';
import { useEffectOnce } from '@custom-react-hooks/all';

const EffectOnceComponent = () => {
  const [fibonacciSequence, setFibonacciSequence] = useState([]);

  const calculateFibonacci = (n) => {
    let sequence = [0, 1];
    for (let i = 2; i < n; i++) {
      sequence[i] = sequence[i - 1] + sequence[i - 2];
    }
    return sequence.slice(0, n);
  };

  useEffectOnce(() => {
    const sequence = calculateFibonacci(5);
    setFibonacciSequence(sequence);
  });

  return (
    <div>
      <p>First {5} numbers in the Fibonacci sequence:</p>
      <ul>
        {fibonacciSequence.map((number, index) => (
          <li key={index}>{number}</li>
        ))}
      </ul>
    </div>
  );
};

export default EffectOnceComponent;
```

在这个例子中, `useEffectOnce` 用于在 `MyComponent`。 。 。 .

## API 参考

### 参数

-   `effect`: 当组件挂起时将执行一次的函数。 此函数可选择返回清理函数, 当组件卸载时执行该函数 .

## 使用大小写

-   **初始设置**: 执行初始数据获取或设置收听器等设置操作.
-   **一次性计算**:计算值仅在组件生命周期内需要一次.
-   **单个 API 呼叫**: 当一个组件首次被提供时, 发出一个 API 呼叫 .
-   **非经常性订阅**: 订阅只应初始化一次的服务或事件收听器.

## 捐款

对加强工作的贡献 `useEffectOnce` 总是欢迎。 随意向存放处提交问题或提出请求以作进一步改进.

## 常见问题

### @custom-react-hooks/use-effect-once 是什么？

useEffectOnce 是React中的自定义钩子,旨在模仿 componentDidMount 财务报告和审定财务报表 componentWillUnmount 类组分中的生命周期方法\. 这是经过修改的版本 useEffect 它只在组件上架时运行一次\.

### 如何安装 @custom-react-hooks/use-effect-once？

在项目目录运行 npm install @custom-react-hooks/use-effect-once，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @custom-react-hooks/use-effect-once 支持 TypeScript 吗？

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

### @custom-react-hooks/use-effect-once 支持 ESM 还是 CommonJS？

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

### @custom-react-hooks/use-effect-once 可以商用吗？

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

### @custom-react-hooks/use-effect-once 的下载量有多少？

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

### @custom-react-hooks/use-effect-once 还在维护吗？

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