简体中文

useNow

Tags:

Utilities

Pausable

一个 React 钩子，用于跟踪当前日期。

演示

源码

Now:

2024-11-12 08:39:59:062

isActive:

false

Now:

1731400799063

Update count:

用法

请查看 API。

源码

点击下方链接跳转 GitHub 查看源代码。

🪝 Hook 🎨 Demo 📄 Document

API

const now = useNow(options)
const { now, ...controls } = useNow({ controls: true, ...otherOptions })

选项 Options

export type UseNowOptions<Controls extends boolean> = UseIntervalFnOptions & {
  /**
   * 暴露控制器
   *
   * @defaultValue false
   */
  controls?: Controls
  /**
   * 更新间隔（毫秒），或使用 requestAnimationFrame
   *
   * @defaultValue requestAnimationFrame
   */
  interval?: UseIntervalFnInterval
  /**
   * 每次更新时的回调函数
   */
  callback?: (now: Date) => void
}

返回值

返回值中包含可暂停、恢复的 Pausable 实例。

更多详情，请参见 Pausable。

如果 controls 为 true，则返回包含 now 和 Pausable 实例的对象，否则返回当前的 Date 实例。

export type UseNowReturns<Controls extends boolean> = Controls extends true ? { now: Date } & Pausable : Date

ON THIS PAGE

#useNow

#演示

#用法

#源码

#API

#选项 Options

#返回值

useNow

演示

用法

源码

API

选项 Options

返回值