Utils

这是可以在 jotai/utils 下找到的 atom creators/hooks utils 的概述。 下面列出了每个实用程序及其 描述/API 的链接。

概览

1. atomWithStorage

   atomWithStorage 函数创建一个原子，其值保存在用于 React 的 localStorage 或 sessionStorage 或用于 React Native 的 AsyncStorage 中。

2. atomWithObservable

   atomWithObservable 函数从 RxJS（或类似的）subject 或 observable 创建一个原子。 它的值将是从流中发出的最后一个值。

3. useUpdateAtom

   使用 useUpdateAtom 和只写原子来避免重新渲染。

4. useAtomValue

   返回给定原子的值。

5. atomWithReset

   创建一个可以使用 useResetAtom hook 重置为其 initialValue 的原子。

6. useResetAtom

   将 Resettable 原子重置为其初始值。

7. RESET

   如果接受 RESET 符号，则由使用 atomWithReset、atomWithDefault 创建的可重置原子或使用 atom 创建的可写原子接受的特殊值。

8. useReducerAtom

   使用此 hook 通过 reducer 函数更新原子值。

9. atomWithReducer

   这是一个创建具有嵌入式 reducer 函数以更新值的原子的函数。

10. atomWithDefault

    这是一个创建可重写原始原子的函数。 它的默认值可以用读取函数而不是静态初始值来指定。

11. atomWithHash

    这将创建一个与 URL 哈希连接的新原子。

12. atomFamily

    这将创建一个接受参数并返回原子的函数。

13. selectAtom

    此函数创建一个派生原子，其值是原始原子值的函数，由 selector 确定。

14. useAtomCallback

    这个 hook 允许命令式地与原子交互。

15. freezeAtom

    freezeAtom 接受一个现有的原子并返回一个新的派生原子。 新派生原子的值将被冻结（即不可变）。

16. freezeAtomCreator

    freezeAtomCreator 不是从现有原子创建冻结原子，而是采用原子创建函数并返回一个新函数。

17. splitAtom

    当您想要为列表中的每个元素获取一个原子时，splitAtom 很有用。

18. waitForAll

    waitForAll 是一个并发 helper，它允许我们等待多个异步原子。

19. useHydrateAtoms

    useHydrateAtoms 的主要用例是像 Next.js 这样的 SSR 应用程序，其中初始值是例如 在服务器上获取，可以通过 props 传递给组件。

20. loadable

    loadable API 将允许您绕过 Jotai 中异步流核心发生的固有 suspense。 用 loadable 包裹你的原子，你可以直接得到你的异步原子的结果作为一个对象，它有一个状态来告诉你 Promise 是否已经解决甚至失败。

21. abortableAtom

    abortableAtom 用于定义具有中止性的派生原子。