nx-xcx-utils
v0.1.15
Published
农信小程序工具库
Downloads
10
Readme
nx-xcx-utils
小程序 js 库。一些类库的封装。
使用此组件需要依赖小程序基础库 2.2.1 以上版本,同时依赖开发者工具的 npm 构建。具体详情可查阅官方 npm 文档。
安装
npm install --save nx-xcx-utils
采集站脚本
configLog配置采集站参数,请在app启动时配置一次即可
proxyLog包装page属性
import { configLog, proxyLog, gatherBehavior } from 'nx-xcx-utils'
//配置采集信息
configLog({
env: 1, //环境信息,根据此配置将请求信息推送至不同的采集站,1:测试 2:预生产 3:正式
code: '采集站分配的码',
getUid: function() { //登录用户的uid,如未登录返回null
return 'xx'
}
});
//上报采集信息,使用代理
Page(proxyLog({
data: {}, ...
}))
//上报采集信息,使用behaviors
behaviors: [gatherBehavior]
登录配置
configLogin配置登录参数,请在app启动时配置一次即可
import { configLogin, login, logout, getLoginUser, loginBehavior } from 'nx-xcx-utils'
//配置登录信息
configLogin({
env: 1, //环境信息,根据此配置将请求信息推送至不同的采集站,1:测试 2:预生产 3:正式
loginPage: '登录页地址',
failPage: '授权失败地址,ex:授权取消',
systemId: 1,
channel: '短信通道',
theme: '主题配置'
});
interface LoginUser {
id: string;
uid: string;
name: string;
nickName: string;
phone: string;
loginName: string;
photo: string;
gender: number;
ticket: string;
}
login(user: LoginUser): Promise<boolean> //登录,将会话信息写入stoge,用户信息使用/oauth/xcx/wx/get-info-by-code获取
/***
* @param flag 是否在未登录时通过绑定填充会话
* @param kfs 是否是小程序开发商模式
*/
getLoginUser(flag: boolean = false, kfs: boolean = false): Promise<LoginUser> //获取登录的用户信息
/***
* @param flag 是否解绑
* @param kfs 是否是小程序开发商模式
*/
logout(flag: boolean = false, kfs: boolean = false): Promise<boolen> // 清理会话信息
//配置页面需要登录信息,使用behaviors
behaviors: [loginBehavior]