Skip to content

Latest commit

 

History

History
122 lines (93 loc) · 9.22 KB

README.md

File metadata and controls

122 lines (93 loc) · 9.22 KB

Pansy Utils

小巧实用的工具类库

Alita NPM version NPM downloads lerna

✨ 特性

  • 🚀 快速,使用简单,每个包只提供一种功能,可单独安装
  • 📦 基于 rollup 进行打包,提供cjsesumd三种格式
  • 💻 使用 TypeScript 构建,提供完整的类型定义文件

🏗 安装

  1. 直接下载public目录下的pansy-utils.min.js使用,支持 UMD 通用模块规范

  2. npm 安装

# npm 安装
npm install @pansy/utils --save

# yarn 安装 推荐
yarn add  @pansy/utils

也可独立安装每个独立的功能包

🔨 使用

  • 浏览器:
<script src="pansy-utils.min.js"></script>
<script>
  var result = pansy.isFunction(() => {});
</script>
  • ES6/TS
import { isFunction } from '@pansy/utils';

const fun = () => {};

if (fun) {
  console.log('is function');
}

推荐使用方法

// 只引入需要使用的包
import isFunction from '@pansy/is-function';

📦 packages

包名 描述
@pansy/array-move 将数组项移动到其他位置
@pansy/delay 休眠函数
@pansy/dent 每一行紧跟前导空白的插入值为多行时,保持缩进,且移除每一行的公共前导空白
@pansy/get-type 检测 value 的类型
@pansy/group-by 根据迭代函数返回的值对数组进行分组。
@pansy/indent 每一行紧跟前导空白的插入值为多行时,保持缩进。
@pansy/is-array 判断当前值是否为数组
@pansy/is-boolean 判断当前值是否为 boolean
@pansy/is-date 判断当前值是否是一个日期
@pansy/is-empty-object 判断当前值是否为一个空对象
@pansy/is-function 判断当前值是否为函数
@pansy/is-integer 判断当前值是否为一个整数
@pansy/is-nan 判断当前值是否为NaN
@pansy/is-negative-integer 判断当前值是否为一个负整数
@pansy/is-nil 判断当前值是否为 null 或 undefined
@pansy/is-null 判断当前值是否为空
@pansy/is-number 判断当前值是否为数字
@pansy/is-object 判断当前值是否为对象
@pansy/is-plain-object 判断当前值是否为简单对象
@pansy/is-promise 判断当前值是否为promise
@pansy/is-regexp 判断当前值是否为正则表达式
@pansy/is-string 判断当前值是否为空
@pansy/is-symbol 判断当前值是否为原始 Symbol 或者 Symbol 对象
@pansy/is-undefined 判断当前值是否为 undefined
@pansy/is-url 判断字符串是否为 Url
@pansy/key-code 一些按键代码定义和实用程序
@pansy/number-precision 解决浮动运算问题,避免小数点后产生多数值和计算精度损失
@pansy/utils 小巧实用的工具类库
@pansy/policy 解析权限策略,并提供验证功能
@pansy/replace-object-keys 替换对象键名,支持普通对象、对象数组以及树对象,支持过滤功能
@pansy/round 对传入的数字按给定的精度返回
@pansy/url-utils url 相关工具方法
@pansy/utility-regexps 常见正则表达式
@pansy/utility-types 实用的类型定义

⌨️ 本地开发

# 克隆项目到本地
git clone [email protected]:pansyjs/utils.git

# 切换到项目目录
cd ./utils

# 安装依赖
yarn bootstarp

🌟 社区互助

Github Issue 钉钉群 微信群
issues