Function

Static Public Summary
public	appendUrl(url: string, params: string \| object, replaceExistParams: boolean): string 在 URL 上追加参数
public	checkUpdate(options: object) 检测是否有新版本建议在 app.js#onShow 中调用
public	getCssString(styleObject: object): string 获取 CSS 样式字符串
public	getCurrentPageUrl(stripQuery: boolean): string 获取当前页面的 URL, 默认会追加当前页面的 query 参数
public	getCurrentPageUrlParams(): object 获取当前页面的 URL 参数
public	getHttpResponseHeaderValue(headerObject: object, name: string): string 获取 HTTP 返回结果中的 header 值
public	hasAuth(scopes: string \| array<string>): * 判断用户是否有授权过某些权限
public	invokePageMethod(methodName: string, args: Array, index: number): any 调用某个页面的方法
public	isGetPhoneNumberSuccess(phoneResult: object): boolean 获取用户手机号回调时判断是否取到了用户信息
public	isGetUserInfoSuccess(userInfoResult: object): boolean 获取用户信息回调时判断是否取到了用户信息
public	navigateBack(options: object): * 封装原生的 navigateBack 方法
public	navigateTo(options: object): * 封装原生的 navigateTo 方法
public	redirectTo(options: object): * 封装原生的 redirectTo 方法
public	reloadCurrentPage(stripQuery: boolean) 刷新当前页面
public	switchTab(options: object): * 封装原生的 `switchTab` 方法

Static Public

public appendUrl(url: string, params: string | object, replaceExistParams: boolean): string source

import {appendUrl} from 'weapp-commons-util/src/util.js'

在 URL 上追加参数

Params:

Name	Type	Attribute	Description
url	string
params	string \| object		要追加在 URL 上的参数
replaceExistParams	boolean		如果原 URL 中已经有了待追加的参数, 是否覆盖, 默认不覆盖注意会使原 URL 中的重复参数合并成一个例如: https://domain.com?a=1&a=2&b=3 追加 a=4 最终 https://domain.com?a=4&b=3

Return:

string

追加了参数的 URL

public checkUpdate(options: object) source

import {checkUpdate} from 'weapp-commons-util/src/util.js'

检测是否有新版本建议在 app.js#onShow 中调用

Params:

Name	Type	Attribute	Description
options	object		options.showModal {boolean} 有新版本时是否显示新版本的提示框 options.modalTitle {string} 新版本提示框的标题 options.modalContent {string} 新版本提示框的内容 options.forceUpdate {boolean} 是否强制升级, 开启强制升级新版本提示框不会有取消按钮 options.checkCallback {Function} 检测更新的回调

public getCssString(styleObject: object): string source

import {getCssString} from 'weapp-commons-util/src/util.js'

获取 CSS 样式字符串

{position:'absolute',top:'10rpx'} => position:absolute;top:10rpx;

Params:

Name	Type	Attribute	Description
styleObject	object

Return:

string

public getCurrentPageUrl(stripQuery: boolean): string source

import {getCurrentPageUrl} from 'weapp-commons-util/src/util.js'

获取当前页面的 URL, 默认会追加当前页面的 query 参数

Params:

Name	Type	Attribute	Description
stripQuery	boolean		是否去除页面的 query 参数, 默认不去除

Return:

string

页面的 URL

public getCurrentPageUrlParams(): object source

import {getCurrentPageUrlParams} from 'weapp-commons-util/src/util.js'

获取当前页面的 URL 参数

Return:

object

页面的 URL 参数

public getHttpResponseHeaderValue(headerObject: object, name: string): string source

import {getHttpResponseHeaderValue} from 'weapp-commons-util/src/util.js'

获取 HTTP 返回结果中的 header 值

例如 header 的名称有如下类型

Connection 单个单词的
ETag 缩写没有使用连字符的
Content-Type 多个单词使用了连字符的

Params:

Name	Type	Attribute	Description
headerObject	object		开发者服务器返回的 HTTP Response Header
name	string

Return:

string

See:

https://developers.weixin.qq.com/miniprogram/dev/api/wx.request.html

public hasAuth(scopes: string | array<string>): * source

import {hasAuth} from 'weapp-commons-util/src/util.js'

判断用户是否有授权过某些权限

如果用户未接受或拒绝过此权限，会弹窗询问用户，用户点击同意后方可调用接口
如果用户已授权，可以直接调用接口；
如果用户已拒绝授权，则不会出现弹窗，而是直接进入接口 fail 回调。请开发者兼容用户拒绝授权的场景。

Params:

Name	Type	Attribute	Description
scopes	string \| array<string>		单个或者多个权限码

Return:

*	Promise<boolean>

See:

public invokePageMethod(methodName: string, args: Array, index: number): any source

import {invokePageMethod} from 'weapp-commons-util/src/util.js'

调用某个页面的方法

Params:

Name	Type	Attribute	Description
methodName	string
args	Array
index	number		默认为当前页

Return:

any

public isGetPhoneNumberSuccess(phoneResult: object): boolean source

import {isGetPhoneNumberSuccess} from 'weapp-commons-util/src/util.js'

获取用户手机号回调时判断是否取到了用户信息

bindgetphonenumber

Params:

Name	Type	Attribute	Description
phoneResult	object

Return:

boolean

public isGetUserInfoSuccess(userInfoResult: object): boolean source

import {isGetUserInfoSuccess} from 'weapp-commons-util/src/util.js'

获取用户信息回调时判断是否取到了用户信息

bindgetuserinfo

Params:

Name	Type	Attribute	Description
userInfoResult	object

Return:

boolean

public navigateBack(options: object): * source

import {navigateBack} from 'weapp-commons-util/src/wx.js'

封装原生的 navigateBack 方法

回退页面时调用回退页的特定方法
判断预期返回的页面

Params:

Name	Type	Attribute	Description
options	object		options._triggerOnNavigateBack {boolean\|string} 激活时默认调用回退页中的 _onNavigateBack 方法, 如果传入的是字符串则表示方法名, 指定调用回退页面中的该方法 options._onNavigateBackArgs {array<any>} 传入 _onNavigateBack 方法的参数 options._expectedBackUrl {string} 预期返回的页面 URL

Return:

public navigateTo(options: object): * source

import {navigateTo} from 'weapp-commons-util/src/wx.js'

封装原生的 navigateTo 方法

扩展 _urlParams 用于在 URL 上追加参数
调用失败时尝试降级为 switchTab 来完成跳转
解决微信小程序只允许跳转 10 层路由的问题, 超过限制后自动变为 redirectTo 跳转页面

Params:

Name	Type	Attribute	Description
options	object		options._urlParams {object} 需要追加到 URL 上的参数

Return:

public redirectTo(options: object): * source

import {redirectTo} from 'weapp-commons-util/src/wx.js'

封装原生的 redirectTo 方法

扩展 _urlParams 用于在 URL 上追加参数
调用失败时尝试降级为 switchTab 来完成跳转

Params:

Name	Type	Attribute	Description
options	object		options._urlParams {object} 需要追加到 URL 上的参数

Return:

public reloadCurrentPage(stripQuery: boolean) source

import {reloadCurrentPage} from 'weapp-commons-util/src/util.js'

刷新当前页面

Params:

Name	Type	Attribute	Description
stripQuery	boolean		是否去除页面的 query 参数, 默认不去除

public switchTab(options: object): * source

import {switchTab} from 'weapp-commons-util/src/wx.js'

封装原生的 switchTab 方法

调用失败时尝试降级为 redirectTo 来完成跳转

Params:

Name	Type	Attribute	Description
options	object