前言
mtae-client-services
是一个能够提供丰富的前端埋点能力的 npm 包,具有易用性和扩展性的同时,也能满足数据收集和分析的需求。在本篇文章中,将详细介绍如何使用 mtae-client-services
,以及如何进行自定义拓展。
安装
在使用 mtae-client-services
前,需要先进行安装。在终端输入以下命令:
npm install mtae-client-services
安装完成后,即可开始使用。
开始使用
mtae-client-services
的主要功能是收集前端数据,为数据分析提供支持。使用之前需要初始化:
-- -------------------- ---- ------- ------ - ---- - ---- ----------------------- ----- ------------ - - -- ---- ------ ----- --- -- ------ -- ------- ---- ------------------------------ -- ---------- ------ ----- -- -------------------展开代码
在上面的代码中,clientConfig
可进行配置,分别是 appId
、api
和debug
。其中,appId
是必填项,用于标识一个应用;api
指定了 API 访问路径;debug
用于指定是否启用打印日志功能。
init
方法完成初始化后,即可开始使用 collect 方法进行相关数据采集。
-- -------------------- ---- ------- ------ - ------- - ---- ----------------------- ----- ---------- - - -- --- --------- ------- -- -- --------- --- -- --------------------展开代码
在上述代码中,pageConfig
配置项包括 pageName
和 referrer
,这两个属性都是可选的,只有在需要对应功能时才用配置,如需要对来源进行跟踪时配置 referrer
。
使用 collect
方法将数据传入,完成数据收集。
自定义拓展
mtae-client-services
提供了自定义插件拓展的方式,实现自定义数据收集需求。
import { eventBus } from "mtae-client-services"; eventBus.on("myCustomEvent", (data) => { console.log(data); });
在上文中,eventBus
用于自定义事件监听,名为 "myCustomEvent"
。可以通过 eventBus.emit("myCustomEvent", data)
方法进行监听事件的触发。
结语
以上就是 mtae-client-services
的使用及自定义扩展方法。相信通过这篇文章的介绍,你已经可以熟练使用其相关功能了。如果有任何问题,欢迎随时联系作者。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600558df81e8991b448d62fc