ks-tool

    1.0.5 • Public • Published

    ks-tool

    ks-tool:轻量级的通用工具库,包括日期转换、类型判断、常用方法等
    

    Project setup

    npm install
    

    Compiles and hot-reloads for development

    npm run dev
    

    Compiles and minifies for production

    npm run build:esm 编译出符合 esm 规范的可执行文件,供 Vue、React 等采用 esmodule 规范进行模块化打包的项目使用
    npm run build:umd 编译出符合 umd 规范的可执行文件,供 jQuery、Vue、NodeJS 等项目使用
    npm run build:min 编译出符合 umd 规范的压缩的可执行文件
    npm run build
    

    Run your unit tests

    npm run test
    

    Lints and fixes files

    npm run lint
    

    use the tool

    npm i -D ks-tool
    example: import { dateFormat } from 'ks-tool'
    

    项目结构

    ├── .babelrc				    // babel配置文件
    ├── package.json				// npm包配置文件,依赖信息
    ├── rollup.config.js			// rollup打包配置
    ├── tsconfig.json			    // ts配置文件
    
    

    方法函数说明

    dateFormat 时间、日期格式化
    
    @param {string} fmt 时间格式,示例 'YY-mm-dd HH:MM:SS'
    @param {Date} date 日期对象
    @return {string} fmt 指定时间格式字符串
    
    dateStringFormat 时间、日期格式化,修复iOS日期转换上的bug, 处理带T的时间格式
    
    @param {string} fmt 时间格式,示例 'YY-mm-dd HH:MM:SS'
    @param {string} date 日期字符串
    @return {string} fmt 指定时间格式字符串
    
    timestampFormat 时间、日期格式化
    
    @param {string} fmt 时间格式,示例 'YY-mm-dd HH:MM:SS'
    @param {number} timestamp 时间戳
    @return {string} fmt 指定时间格式字符串
    
    hasOwn 判断对象是否存在属性
    
    @param {object} val 对象
    @param {string | symbol} key 属性
    @return {boolean} 对象是否存在该属性
    
    toNumber 转换成数字
    
    @param {any} val 一般是字符串或数字
    @return {number} 数字
    
    remove 删除数组内元素(元素可以是number、string,非object)
    
    @param {T[]} arr 数组对象
    @param {T} el 数组内元素
    @return without 直接修改arr
    
    throttle 节流函数
    
    @param {Function} fn 函数方法
    @param {number} duration 节流间隔时长
    
    debounce 防抖函数
    
    @param {Function} fn 函数方法
    @param {number} delay 防抖间隔时长
    
    formatSize 格式化文件大小
    
    @param {any} value 文件大小
    @return {string} size 格式化后的文件大小字符串
    
    padZero 数字或字符串补0
    
    @param {number | string} num 数字或字符串
    @param {number = 2} targetLength 补0长度
    @return {string} str 补0后的字符串
    
    downLoadFile 下载(避免浏览器拦截),打开新窗口
    
    @param {string} url 下载链接
    @param {string} name 下载保存的文件名称
    
    downLoadFileFrame 下载(避免浏览器拦截),不打开新窗口下载
    
    @param {string} url 下载链接
    @param {string} name 下载保存的文件名称
    
    filterInput 输入安全过滤
    
    @param {string} s 需要过滤的输入字符串
    @param {string} s 过滤后的字符串
    
    deepAssign 合并两个对象,相同属性,后面的会覆盖前面的
    
    @param {ObjectIndex} to 需要合并的对象
    @param {ObjectIndex} from 需要合并的对象
    @return {ObjectIndex} to 合并后的对象
    
    deepClone 深拷贝
    
    @param {Record} obj 需要拷贝的对象
    @return {Record} obj 拷贝出来的对象
    
    validate 类型判断或转换系列函数,包括(isDate、isArray、isiOS、isWx等)
    
    objectToString 原型toString方法
    toTypeString 转换成字符串
    isArray 判断是否数组
    isNumeric 判断是否数字
    isMap 判断是否Map
    isSet 判断是否Set
    isFunction 判断是否是函数
    isString 判断是否字符串
    isSymbol 判断是否原始数据类型
    isObject 判断是否对象
    isPromise 判断是否Promise函数
    isDef 判断对象是否定义
    isDate 判断是否是日期
    isEmail 判断是否是邮箱
    isMobile 判断是否手机号
    isNaN 判断是否NaN
    isiOS 判断是否iOS系统
    isAndroid 判断是否Android系统
    isWx 判断是否微信环境
    isPC 判断是否PC环境
    
    addUnit 添加px单位
    
    @param {string | number} value 添加单位的字符串或数字
    @return {string | undefined} str 返回带px的字符串
    
    unitToPx 计算转换适配的单位to px
    
    @param {string | number} value 带rem、vm、vh的单位数字或字符串
    @return {string | undefined} int 返回转换后的数字
    

    Install

    npm i ks-tool

    DownloadsWeekly Downloads

    0

    Version

    1.0.5

    License

    ISC

    Unpacked Size

    55.5 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar