ReportRate

类型：interface

日志上报采样率配置

reportRate

类型：number

设置默认日志采样率，取值范围为[0, 1]，1 代表全部上报。

reportRateError

类型：number

设置默认错误日志采样率，取值范围为[0, 1]，1 代表全部上报。

GlobalConfigOptions

类型：interface

全局配置项

enableBalanceDomain

类型：false | string[] | undefined

是否开启域名均衡功能。

• false：不开启
• string[]：开启并传入域名列表，需配合 loader 使用，示例如下所示。

注意

需提前配置在 veImageX 服务中配置多个域名。

示例

const myLoader = (props) => {
  const { src, width, quality, format, balancedDomain = 'example.com' } = props
  return `https://${balancedDomain}/${src}~tplv-serviceId-resize:${width}:q${quality}.${format}`
}

forceRunSync

类型：boolean | undefined

是否启用强制同步执行。

• true：启用
• false：不启用

注意

SDK 内部执行逻辑原本为异步，若开启此项，则将变为同步逻辑。
开启强制同步执行时，若端上无格式探测缓存，则会默认加载原图格式图片。

updateGlobalConfig()

更新全局配置。

类型

(options: GlobalConfigOptions) => void

参数

返回值

Callback

日志上报回调。

类型

(evtName: string, params: Record<string, unknown>) => void

LoggerOptions

类型：interface

日志配置。

region

类型："cn" | "sg"

区域。

• cn：国内
• sg：新加坡

appId

类型：number

应用 ID。您可以登录 ImageX 控制台的应用管理，查看账号下已创建应用的应用 ID。

userUniqueId

类型：string

用于上报的用户唯一标识，建议自定义。如不设置，会生成随机 ID 并存储小程序缓存中。

enableCloudConfig

类型：boolean | undefined

是否启用云端配置下发。

• true：开启
• false：（默认）关闭

注意

当您需要开启云端配置下发时，请在您的小程序后台额外添加云控配置域名：https://imagex-web-settings.volcimagex.net。

reportRateConfig

类型：ReportRate | undefined

默认的日志采样率配置。

callback

类型：Callback | undefined

日志上报回调，将上报的日志指标信息传入该函数，供开发者自行消费。

initLoggerInstance

值：'loggerInstance.init'

初始化日志上报实例。

updateReportParams

值：'loggerInstance.updateReportParams'

更新自定义上报内容。

registerLoader

值：'loaderManager.registerLoader'

注册加载器。