useReportingObserver

一个 React 钩子(Hook),帮助您方便地使用 ReportingObserver API 报告错误和警告。

演示

源码See log in console for reports

用法

请查看 API。

源码

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

API

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

回调函数 Callback

ReportingObserverCallback 函数,当观测器被触发时会调用此函数。

选项 Options

export type UseWebObserverOptions = {
  /**
   * 调用此函数后立即启动观测器
   *
   * @defaultValue true
   */
  immediate?: boolean
}

interface ReportingObserverOptions {
  buffered?: boolean
  types?: string[]
}

export interface UseReportingObserverOptions extends UseWebObserverOptions, ReportingObserverOptions {}

返回值

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

更多详情,请参见 Pausable

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

export interface UseReportingObserverReturns extends UseWebObserverReturns<ReportingObserver> {}