@custom-react-hooks/use-effect-once

中文文档
1.5.1发布于 2024/08/18MITTypeScriptCommonJS零依赖近 30 天下载 3490

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

中文使用文档
文档目录10 节
  1. 特征
  2. 安装
  3. 只安装当前钩
  4. 安装全部钩
  5. 导入虎克
  6. 使用量
  7. API 参考
  8. 参数
  9. 使用大小写
  10. 捐款

使用效果

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

特征

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

安装

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

只安装当前钩

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

或者说

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

安装全部钩

npm install @custom-react-hooks/all

或者说

yarn add @custom-react-hooks/all

导入虎克

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

已命名的导入 :

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

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

使用量

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 共发布 8 个版本,首次发布于 2023/12/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.1latest2024/08/182 年前
1.5.02024/08/182 年前
1.4.192023/12/092 年前
1.4.182023/12/082 年前
1.4.162023/12/072 年前
1.4.152023/12/022 年前

关于 @custom-react-hooks/use-effect-once 的常见问题

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