# uni.getPerformance

获取性能管理对象 Performance 实例

# getPerformance 兼容性 ?

Web 微信小程序 支付宝小程序 Android(VDOM) Android(Vapor) iOS(VDOM) iOS(Vapor) HarmonyOS(VDOM) HarmonyOS(Vapor)
x 4.41 5.31 3.91 x 4.25 x 4.61 x

# 返回值

类型 描述
Performance 性能管理对象

# Performance 的方法

# createObserver(callback: PerformanceObserverCallback): PerformanceObserver

createObserver 创建全局性能事件监听器

# createObserver 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
callback (entries: PerformanceObserverEntryList) => void 是
# PerformanceObserverEntryList 的方法
# getEntries(): PerformanceEntry[]

getEntries 该方法返回当前列表中的所有性能数据

# getEntries 兼容性 ?
Web
x
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。
# getEntriesByType(entryType: string): PerformanceEntry[]

getEntriesByType 获取当前列表中所有类型为 [entryType] 的性能数据

# getEntriesByType 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
entryType string 是
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。
# getEntriesByName(name: string, entryType: string): PerformanceEntry[]

getEntriesByName 获取当前列表中所有名称为 [name] 且类型为 [entryType] 的性能数据

# getEntriesByName 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
name string 是
entryType string 是
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。
# 返回值
类型 描述
PerformanceObserver 性能事件监听器对象
# PerformanceObserver 的方法
# observe(options: PerformanceObserverOptions): void

observe 开始监听

# observe 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性 描述
options PerformanceObserverOptions 是
性能监听参数
名称 类型 必备 兼容性
buffered boolean 否
entryTypes Array<string> 否
type string 否
# disconnect(): void

disconnect 停止监听

# disconnect 兼容性 ?
Web
x

# getEntries(): PerformanceEntry[]

getEntries 该方法返回当前缓冲区中的所有性能数据

# getEntries 兼容性 ?
Web
x
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。

# getEntriesByType(entryType: string): PerformanceEntry[]

getEntriesByType 获取当前缓冲区中所有类型为 [entryType] 的性能数据

# getEntriesByType 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
entryType string 是
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。

# getEntriesByName(name: string, entryType: string): PerformanceEntry[]

getEntriesByName 获取当前缓冲区中所有名称为 [name] 且类型为 [entryType] 的性能数据

# getEntriesByName 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
name string 是
entryType string 是
# 返回值
类型
Array<PerformanceEntry>
名称 类型 必备 兼容性 描述
entryType string 是
指标类型
name string 是
指标名称
duration number 是
耗时 ms。仅对于表示阶段的指标有效。
startTime number 是
开始时间,不同指标的具体含义会有差异。
path string 否
页面路径。仅 render 和 navigation 类型指标有效。
referrerPath string 否
页面跳转来源页面路径。仅 route 指标有效。
pageId number 否
path 对应页面实例 Id(随机生成,不保证递增)。仅 render/navigation 指标有效。
referrerPageId number 否
referrerPath对应页面实例 Id(随机生成,不保证递增)。仅 route 指标有效。
navigationStart number 否
路由真正响应开始时间。仅 navigation 类型指标有效。
navigationType string 否
路由详细类型,与路由方法对应。仅 navigation 类型指标有效。
initDataRecvTime number 否
首次渲染参数在渲染层收到的时间。仅 firstRender 指标有效。
viewLayerRenderEndTime number 否
渲染层执行渲染结束时间。仅 firstRender 指标有效。

# setBufferSize(size: number): void

setBufferSize 设置缓冲区大小,默认缓冲 30 条性能数据

# setBufferSize 兼容性 ?
Web
x
# 参数
名称 类型 必填 兼容性
size number 是

# 参见

# 通用类型

# GeneralCallbackResult

名称 类型 必备 描述
errMsg string 是 错误信息