npm.io
2.0.0 • Published 1 month ago

jun-utils

Licence
ISC
Version
2.0.0
Deps
0
Size
538 kB
Vulns
0
Weekly
0
Stars
7

jun-utils

前端通用工具函数库:校验、数据转换、浮点数运算、树结构操作等 9 个模块,提供 ES module 与 UMD 两种产物。

Installation

Install with npm:

npm install --save-dev jun-utils

Install with yarn:

yarn add jun-utils --dev

浏览器支持

面向现代浏览器(Chrome 69+ / Safari 12+ / Firefox 62+ / Edge 79+,2018-09 起的全量版本),不支持 IE。

  • dist【UMD】:Number.isFinite 等内建已由构建链内置 core-js@2 兜底
  • lib【ESM】:不做 polyfill,需运行环境或消费方 polyfill 方案支持 ES2019 内建【如 Array.prototype.flatMap】

Usage

ES6 module:

import { check } from 'jun-utils'; // import check from 'jun-utils/lib/check';

// 手机号码校验
check.cellphone('13456789012'); // true

Script:

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>jun-utils</title>
  <script src="jun-utils.min.js"></script>
</head>
<body>
  <script type="text/javascript">
    junUtils.check.cellphone('13456789012'); // true
  </script>
</body>
</html>

API

模块 说明 函数
appUtil app 交互 10
check 校验库 19
common 通用方法 3
convert 数据转换 9
cookie cookie 操作 3
crypt 加密解密【用于暴露在 url 中的重要参数】 2
dom DOM 视口与元素操作 9
event 事件操作 4
floatUtil 浮点数运算【解决精度问题】 4
stringUtil 字符串处理 1
treeUtil 树结构数据操作 3
ws webSocket【断线重连】 1

各函数的参数、返回值与示例见对应模块文档;安装后在 IDE 中悬停函数名可查看同样内容的 JSDoc。docs/api 与本索引表由源码 JSDoc 自动生成(npm run docs:gen),改函数请改 JSDoc,勿手改生成文件。

Keywords