vtils

Home > utils

utils package

基础工具库。基于 Lodash

Classes

| Class | Description | | — | — | | EventBus | 事件巴士,管理事件的发布与订阅。 TListeners 事件名称及其对应的回调描述 | | RichUrl | 富链接,同普通链接相比,富链接可包含一些描述信息。结构描述:

rich://{"url":"***","desc":"***"}

| | TreeData | 树数据处理。支持单根节点、多根节点树数据。 | | Wechat | 对微信 JSSDK 的封装。 |

Enumerations

Enumeration Description
LoadResourceUrlType 资源类型。

Functions

Function Description
base64Decode(value) 将给定的 base64 字符串解码为 UTF8 字符串。
base64Encode(value) 将给定的 UTF8 字符串编码为 base64 字符串。
base64UrlDecode(value) 将给定的 base64url 字符串解码为 UTF8 字符串。
base64UrlEncode(value) 将给定的 UTF8 字符串编码为 URL 安全的 base64url 字符串。
bindEvent(target) 绑定事件。
chooseFile(accept, multiple) 选择文件。
constantCase(text) 转换文本为大写字符串,单词之间带有下划线。
copyTextToClipboard(text) 复制文本到剪切板。
createSubmit(options) 创建提交类行为。
createUrlQueryString(parameters, options) 创建 url 查询字符串。
dedent(literals, interpolations) 首先,每一行紧跟前导空白的插入值为多行时,保持缩进。 然后,移除每一行的公共前导空白。
formatBytes(value) 格式化字节数,以 1024 作为千字节数。
formatNumber(value, options) 格式化数字。
getEnvironment() 获取运行环境信息。
getWechatPublicAccountQrcodeUrl(accountId) 获取微信公众号的二维码链接。
inAndroid() 检查是否在 Android 设备中。
inBrowser() 检查是否在浏览器环境中。
inDeno() 检查是否在 Deno 中。
indent(literals, interpolations) 每一行紧跟前导空白的插入值为多行时,保持缩进。
inIOS() 检查是否在 iOS 设备中。
inMiniProgram(brand) 检查是否在指定品牌的小程序中,若在,返回承载其 API 的全局对象,若不在,返回 false。
inNodeJS() 检查是否在 Node.js 中。
inTaro() 检查是否在 [Taro 3](https://taro.js.org/) 中。
inWechatWebView() 检查是否在微信内置浏览器中。
isBlobUrl(value) 检测传入值是否是 Blob URL,也称 Object URL。
isChineseIDCardNumber(value) 检测传入的值是否是合法的中国大陆居民 18 位身份证号码。
isDataUrl(value) 检测传入值是否是 Data URL。
isNumeric(value) 检查 value 是否是数值,需要注意的是 Infinity-InfinityNaN 不被认为是数值。
isPossibleChineseMobilePhoneNumber(value) 检测传入的值是否可能是中国的手机号码。
isPromiseLike(value) 检查 value 是否像 Promise
isUrl(value) 检测传入值是否是 URL。
loadCss(urlOrContent) 加载 CSS 样式,支持链接和内容。
loadResource(url) 加载图片、代码、样式等资源。
md5(string, key, raw) 根据给定的字符串计算 MD5 值。
move(arr, from, to) 原地移动数组中的元素。
onceMeanwhile(fn) 同一时间对函数的调用只会触发一次运行。
parseDataUrl(dataUrl) 解析 Data URL。
parseUrlQueryString(query, options) 解析 url 查询字符串。兼容以 ? 开头的查询字符串,因此你可以直接传入 location.search 的值。
pascalCase(text) 转换文本为没有分隔符的大写单词字符串。
placeKitten(size) 给定大小获取占位猫咪图片。
placeKitten(width, height) 给定宽高获取占位猫咪图片。
readFile(file) 读取给定文件的内容。
run(fn) 以数组的方式返回函数执行的结果,如果函数返回一个异步操作,将会执行该异步操作并将其结果作为函数执行的结果返回。
swap(arr, i, j) 原地交换数组中的两个元素。
traverse(value, callback) 遍历对象和数组。
wait(milliseconds, value) 等待一段时间 resolve。

Interfaces

Interface Description
CreateSubmitOptions  
CreateUrlQueryStringOptions  
EventBusListenerDescriptor  
EventBusOptions  
FormatNumberOptions 格式化数字选项。
GetEnvironmentResult  
LoadCssResult  
LoadResourceUrl 资源地址。
ParseDataUrlResult  
ParsedFileRichUrl  
ParsedRichUrl  
ReadFileReader 各种内容类型的读取器。
SubmitActionPayload  
TreeDataNode  
TreeDataOptions  
TreeDataTraverseFnPayload  
WaitResult  
WechatChooseImageParams  
WechatConfigParams  
WechatOpenLocationParams  
WechatPreviewImageParams  
WechatRequestPaymentParams  
WechatUpdateShareDataParams  
WechatUploadImageParams  

Namespaces

Namespace Description
isBlobUrl  
isDataUrl  
wait  

Variables

Variable Description
keysStrict keys,不过采用了严格的类型定义。
omitStrict omit,不过采用了严格的类型定义。
pickStrict pick,不过采用了严格的类型定义。

Type Aliases

Type Alias Description
BindEventFunction 绑定事件函数。
CreateSubmitResult  
EventBusBeforeEmit  
EventBusBeforeOn  
EventBusListener  
EventBusListeners  
EventBusListenerTag  
EventBusOffListener  
MiniProgramApi  
MiniProgramBrand  
TreeDataChildrenPropName  
TreeDataData  
TreeDataMultipleRootData  
TreeDataSearchStrategy  
TreeDataSingleRootData  
TreeDataTraverseFn  
WechatErrorCallback  
WechatJsApi 微信 JSSDK 支持的 API。
WechatNonBaseMenuItem 微信内网页的非基础菜单列表。