usePerformanceObserver

一个 React Hook,帮助您轻松使用 PerformanceObserver API

演示

尝试打开 DevTools 以查看性能观察器日志。

源码
isSupported:
false
observerRef:
not ready

用法

请查看 API。

源码

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

API

const { observerRef, isSupported, ...controls } = usePerformanceObserver(callback, options)

回调函数 Callback

当观察器被触发时将会调用的 PerformanceObserverCallback 函数。

选项 Options

export type UseWebObserverOptions = {
  /**
   * 在调用此函数后立即开始观察器
   *
   * @defaultValue true
   */
  immediate?: boolean
}

interface PerformanceObserverInit {
  buffered?: boolean
  entryTypes?: string[]
  type?: string
}

export type UsePerformanceObserverOptions = UseWebObserverOptions & PerformanceObserverInit

返回值

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

更多详情,请参见 Pausable

export type UseWebObserverReturns<Observer> = Pausable & {
  /**
   * 保持观察器实例的 ref
   */
  observerRef: React.MutableRefObject<Observer | null>
  /**
   * 检查当前环境是否支持观察器
   */
  isSupported: boolean
}

export type UsePerformanceObserverReturns = UseWebObserverReturns<PerformanceObserver>