/** * @license * Funclib v6.0.6 * GitHub Repository * Released under MIT license */ /**================================================================ * [c]: Client side method 客户端方法 * [s]: Server side method 服务端方法 * [-]: Common method 服务端和客户端通用的方法 * ---------------------------------------------------------------- ## Type * fn.typeOf [-] 检查值的类型 * fn.typeVal [-] 获取期望类型的值 * fn.isStr [-] 判断类型是否为：string * fn.isNum [-] 判断类型是否为：number * fn.isBol [-] 判断类型是否为：boolean * fn.isFun [-] 判断类型是否为：function * fn.isNul [-] 判断是否为：null * fn.isUdf [-] 判断类型是否为：undefined * fn.isErr [-] 判断类型是否为：Error * fn.isDat [-] 判断类型是否为：Date * fn.isReg [-] 判断类型是否为：RegExp * fn.isArr [-] 判断类型是否为：Array * fn.isObj [-] 判断是否为：正常Object ## Array * fn.array [-] 返回指定长度和默认值的数组 * fn.range [-] 返回一个范围数组 * fn.toArr [-] 值数组化 * fn.indexOf [-] 寻找值在数组中的索引 * fn.find [-] 根据条件寻找值 * fn.filter [-] 根据条件取过滤值 * fn.reject [-] 根据条件过滤值 * fn.contains [-] 判断数组是否包含符合条件的值 * fn.drop [-] 去掉空数组空对象及布尔化后为false的值 * fn.flatten [-] 把有结构的数组打散，减少层数 * fn.pluck [-] 把结构中的字段取出合并到一个数组中 * fn.uniq [-] 去重或根据字段去重 * fn.each [-] 遍历数组或类数组, 同: fn.forEach * fn.forEach [-] 遍历数组或类数组 * fn.sortBy [-] 返回对象数组根据字段排序后的副本 ## Object * fn.len [-] 获取对象自有属性的个数 * fn.has [-] 判断对象是否存在某自有属性 * fn.get [-] 返回对象或子孙对象的属性，可判断类型 * fn.set [-] 设置对象或子孙对象的属性 * fn.keys [-] 返回对象的键值数组 * fn.pick [-] 获取包含部分属性的对象副本 * fn.omit [-] 获取省略部分属性的对象副本 * fn.extend [-] 给对象赋值，可指定字段 * fn.forIn [-] 遍历对象的可数自有属性 * fn.deepCopy [-] 深拷贝数组或对象 * fn.isEmpty [-] 判断对象是否为空对象或数组 * fn.isDeepEqual [-] 判断数组或对象是否相等 ## Math * fn.random [-] 返回指定范围的随机数 * fn.randomId [-] 返回指定长度的随机ID * fn.randomColor [-] 返回一个随机色值 ## Time * fn.interval [-] 循环定时器 * fn.timeout [-] 延时定时器 * fn.defer [-] 延迟执行函数 * fn.time [-] 返回一个时间戳, 同：fn.timestamp * fn.timestamp [-] 返回一个时间戳 * fn.asUtcTime [-] 转化为相同时间的UTC时间戳 * fn.asXyzTime [-] 转化为相同时间指定时差的时间戳 * fn.fmtDate [-] 获取格式化的时间字符串 * fn.fmtUtcDate [-] 获取格式化的UTC时间字符串 * fn.fmtXyzDate [-] 获取格式化指定时差的时间字符串 ## String * fn.match [-] 字符串匹配 * fn.pretty [-] 转换成格式化字符串 * fn.escape [-] 编码HTML字符串 * fn.unescape [-] 解码HTML字符串 * fn.capitalize [-] 字符串首字母大写 * fn.fmtCurrency [-] 格式化显示货币 * fn.maskString [-] 编码字符串或其子串 * fn.cutString [-] 裁切字符串到指定长度 * fn.parseQueryStr [-] 解析Url参数成对象 * fn.stringifyQueryStr [-] 把对象编译成Url参数 ## RegExp * fn.setPattern [-] 设置一个正则表达式 * fn.getPattern [-] 获取一个通用的正则表达式 * fn.testPattern [-] 用一个或几个通用正则测试 * fn.matchPattern [-] 与一个或几个通用正则匹配 ## Function * fn.rest [-] 获取函数的剩余参数 * fn.throttle [-] 节流函数 * fn.debounce [-] 防抖函数 ## Loger * fn.chalk [s] 返回带颜色的字符串 * fn.print [c][s] 在控制台打印值 * fn.log [c][s] 在控制台打印格式化的值 ## Tools * fn.rd [s] 读文件 * fn.wt [s] 写文件 * fn.cp [s] 复制文件夹和文件 * fn.mv [s] 移动文件夹和文件 * fn.rm [s] 删除文件夹和文件 * fn.mk [s] 创建文件夹 * fn.size [s] 获取文件的大小 * fn.clear [s] 控制台清屏 * fn.copyText [c] 复制文本到粘贴板 ## Progress * fn.progress [s] 进度显示工具 * fn.progress.stop [s] 停止进度，结束后触发回调 ## Utility * fn.chain [-] 返回链接调用对象 * fn().method [-] 返回链接调用对象 * fn.noConflict [-] 释放fn变量占用权 * fn.version [-] 返回当前函数库版本 ================================================================*/ export = fn; export as namespace fn; declare var fn: fn.Funclib; declare namespace fn { interface Funclib extends Any { /** * [fn.version] 获取版本号 */ version: string; /** * [fn.progress] 进度显示工具 */ progress: Progress; /** * [fn().method] 使用OOP风格的调用 * @param value : any 目标方法的第一个参数 */ (value?: any): any; /** * [fn.typeOf] 检查值的类型 * @param value : any * @param type_ : string|string[] * @param types : ...string[] */ typeOf(value: any, type_: Type | Type[] | any, ...types: Type[]): boolean; /** * [fn.typeVal] 获取期望类型的值 * @param value : any * @param type_ : string|string[] * @param types : ...string[] */ typeVal(value: any, type_: Type | Type[], ...types: Type[]): any; /** * [fn.isStr] 判断类型是否为：string * @param value : any */ isStr(value: any): boolean; /** * [fn.isNum] 判断类型是否为：number * @param value : any * @param impure : boolean = false */ isNum(value: any, impure?: boolean): boolean; /** * [fn.isBol] 判断类型是否为：boolean * @param value : any */ isBol(value: any): boolean; /** * [fn.isFun] 判断类型是否为：function * @param value : any */ isFun(value: any): boolean; /** * [fn.isNul] 判断是否为：null * @param value : any */ isNul(value: any): boolean; /** * [fn.isUdf] 判断类型是否为：undefined * @param value : any */ isUdf(value: any): boolean; /** * [fn.isErr] 判断类型是否为：Error * @param value : any */ isErr(value: any): boolean; /** * [fn.isDat] 判断类型是否为：Date * @param value : any */ isDat(value: any): boolean; /** * [fn.isReg] 判断类型是否为：RegExp * @param value : any */ isReg(value: any): boolean; /** * [fn.isArr] 判断类型是否为：Array * @param value : any */ isArr(value: any): boolean; /** * [fn.isObj] 判断是否为：正常Object * @param value : any */ isObj(value: any): boolean; /** * [fn.array] 返回一个指定长度和默认值的数组 * @param length : number * @param value : any|function [?] */ array(length: number): number[]; array(length: number, value: T): T[]; /** * [fn.range] 返回一个范围数组 * @param start : number [?] * @param length : number */ range(length: number): number[]; range(start: number, length: number): number[]; /** * [fn.toArr] 值数组化 * @param value : any */ toArr(value: any): any[]; /** * [fn.indexOf] 寻找值在数组中的索引 * @param srcArr : array|string * @param predicate : object|function|any */ indexOf(srcArr: T[], predicate: (item: T) => boolean): number; indexOf(srcArr: T[], predicate: { [key: string]: any }): number; indexOf(srcArr: any[] | string | any, predicate: any): number; /** * [fn.find] 根据条件取值 * @param srcArr : array * @param predicate : object|function|any */ find(srcArr: T[], predicate: (item: T) => boolean): T; find(srcArr: T[], predicate: { [key: string]: any }): T; find(srcArr: any[] | any, predicate: any): any; /** * [fn.filter] 根据条件取过滤值 * @param srcArr : array * @param predicate : object|function|any */ filter(srcArr: T[], predicate: (item: T) => boolean): T[]; filter(srcArr: T[], predicate: { [key: string]: any }): T[]; filter(srcArr: any[] | any, predicate: any): any[]; /** * [fn.reject] 根据条件过滤值 * @param srcArr : array * @param predicate : object|function|any */ reject(srcArr: T[], predicate: (item: T) => boolean): T[]; reject(srcArr: T[], predicate: { [key: string]: any }): T[]; reject(srcArr: any[] | any, predicate: any): any[]; /** * [fn.contains] 判断数组是否包含符合条件的值 * @param srcArr : array * @param predicate : object|function|any */ contains(srcArr: T[], predicate: (item: T) => boolean): boolean; contains(srcArr: T[], predicate: { [key: string]: any }): boolean; contains(srcArr: any[] | any, predicate: any): boolean; /** * [fn.drop] 去掉空数组、空对象及布尔化后为false的值 * @param srcArr : array * @param isDrop0 : boolean = false */ drop(srcArr: T[], isDrop0?: boolean): T[]; drop(srcArr: any[] | any, isDrop0?: boolean): any[]; /** * [fn.flatten] 把有结构的数组打散，减少层数 * @param srcArr : array * @param isDeep : boolean = false */ flatten(srcArr: any[], isDeep?: boolean): any[]; /** * [fn.pluck] 把结构中的字段取出合并到一个数组中 * @param srcArr : array * @param pathStr : string */ pluck(srcArr: any, pathStr: string): any[]; /** * [fn.uniq] 去重或根据字段去重 * @param srcArr : array * @param pathStr : string [?] * @param isDeep : boolean = true */ uniq(srcArr: T[], pathStr?: string, isDeep?: boolean): T[]; uniq(srcArr: any[] | any, pathStr?: string, isDeep?: boolean): any[]; /** * [fn.each] 遍历数组或类数组 * @param srcObj : array|object * @param iteratee : function */ each(srcObj: T[], iteratee: (value: T, index?: number) => void): void; each(srcObj: T, iteratee: (value: any, key?: keyof T) => void): void; each(srcObj: any, iteratee: any): void; /** * [fn.forEach] 遍历数组或类数组 * @param srcObj : array|object * @param iteratee : function */ forEach(srcObj: T[], iteratee: (value: T, index?: number) => void): void; forEach(srcObj: T, iteratee: (value: any, key?: keyof T) => void): void; forEach(srcObj: any, iteratee: any): void; /** * [fn.sortBy] 返回对象数组根据字段排序后的副本 * @param srcArr : array * @param fieldPath : string * @param isDesc : boolean = false */ sortBy(srcArr: T[], fieldPath: string, isDesc?: boolean): T[]; sortBy(srcArr: any[] | any, fieldPath: string, isDesc?: boolean): any[]; /** * [fn.len] 获取对象自有属性的个数 * @param srcObj : any */ len(srcObj: any): number; /** * [fn.has] 判断对象是否存在某自有属性 * @param srcObj : object * @param property : string * @param types : ...string[] */ has(srcObj: any, property: string, ...types: Type[]): boolean; /** * [fn.get] 返回对象或子孙对象的属性，可判断类型 * @param srcObj : object * @param pathStr : string * @param types : ...string[] */ get(srcObj: Object, pathStr: string, ...types: Type[]): any; /** * [fn.set] 设置对象或子孙对象的属性 * @param srcObj : object * @param pathStr : string * @param value : any */ set(srcObj: Object, pathStr: string, value: any): void; /** * [fn.keys] 获取对象的键数组 * @param srcObj : object */ keys(srcObj: Object): string[]; /** * [fn.pick] 获取包含部分属性的对象副本 * @param srcObj : object * @param options : { default?: any } [?] * @param predicate : function|string|string[]|{ default?: any } * @param props : ...string[] */ pick(srcObj: T, predicate: (key: keyof T, value?: any) => boolean): any; pick(srcObj: T, options: { default?: any }, predicate: (key: keyof T, value?: any) => boolean): any; pick(srcObj: any, predicate: { default?: any } | any, ...props: string[]): any; /** * [fn.omit] 获取省略部分属性的对象副本 * @param srcObj : object * @param options : { default?: any } [?] * @param predicate : function|string|string[] * @param props : ...string[] */ omit(srcObj: T, predicate: (key: keyof T, value?: any) => boolean): any; omit(srcObj: T, options: { default?: any }, predicate: (key: keyof T, value?: any) => boolean): any; omit(srcObj: any, predicate: { default?: any } | any, ...props: string[]): any; /** * [fn.extend] 给对象赋值 * @param tarObj : object * @param srcObj : object * @param options : { default?: any } [?] * @param predicate : function|string|string[]|{ default?: any } * @param props : ...string[] */ extend(tarObj: any, srcObj: T, predicate: (key: keyof T, value?: any) => boolean): any; extend(tarObj: any, srcObj: T, options: { default?: any }, predicate: (key: keyof T, value?: any) => boolean): any; extend(tarObj: any, srcObj: any, predicate?: { default?: any } | any, ...props: string[]): any; /** * [fn.forIn] 遍历对象的可数自有属性 * @param srcObj : object * @param iteratee : function */ forIn(srcObj: T, iteratee: (key: keyof T, value?: any) => void): void; forIn(srcObj: T[], iteratee: (index: number, value?: T) => void): void; forIn(srcObj: any, iteratee: any): any; /** * [fn.deepCopy] 深拷贝对象或数组 * @param srcObj : object */ deepCopy(srcObj: T): T; /** * [fn.isEmpty] 判断对象是否为空对象或数组 * @param srcObj : object */ isEmpty(srcObj: any): boolean; /** * [fn.isDeepEqual] 判断数组或对象是否相等 * @param obj1 : object|array * @param obj2 : object|array * @param isStrict : boolean = false */ isDeepEqual(obj1: any, obj2: any, isStrict?: boolean): boolean; /** * [fn.random] 返回一个指定范围内的随机数 * @param start : number * @param end : number [?] * @param isInt : boolean = true; */ random(start?: number, end?: number, isInt?: boolean): number; /** * [fn.randomId] 返回一个指定长度的随机ID * @param length : number = 12 * @param charSet: string? * charSet presets: [pwd] | [0-9] | [a-z] | [A-A] | [0-9a-z]... | string. */ randomId(length?: number, charSet?: string): string; /** * [fn.randomColor] 返回一个随机颜色色值 */ randomColor(): string; /** * [fn.interval] 循环定时器 * @param timerId : string [?] * @param duration : number|false|null [?] * @param callback : function * @param leading : boolean [?] */ interval(timerId: any, duration?: any, callback?: any, leading?: any): Timer; /** * [fn.timeout] 延时定时器 * @param timerId : string [?] * @param duration : number|false|null [?] * @param callback : function * @param leading : boolean [?] */ timeout(timerId: any, duration?: any, callback?: any, leading?: any): Timer; /** * [fn.defer] 延迟执行函数 * @param func : function */ defer(func: Function): void; /** * [fn.time] 返回一个时间戳 * @param time : date|string|number */ time(time: Date | string | number): number; /** * [fn.timestamp] 返回一个时间戳 * @param time : date|string|number */ timestamp(time: Date | string | number): number; /** * [fn.asUtcTime] 转化为相同时间的UTC时间戳 * @param time : date|string|number */ asUtcTime(time: Date | string | number): number; /** * [fn.asXyzTime] 转化为相同时间的指定时差的时间戳 * @param time : date|string|number * @param offset : number */ asXyzTime(time: Date | string | number, offset: number): number; /** * [fn.fmtDate] 获取格式化的时间字符串 * @param fmtStr : string * @param time : date|string|number */ fmtDate(fmtStr: string, time: Date | string | number): string; /** * [fn.fmtUtcDate] 获取格式化的UTC时间字符串 * @param fmtStr : string * @param time : date|string|number */ fmtUtcDate(fmtStr: string, time: Date | string | number): string; /** * [fn.fmtXyzDate] 获取格式化指定时差的时间字符串 * @param fmtStr : string * @param time : date|string|number * @param offset : number */ fmtXyzDate(fmtStr: string, time: Date | string | number, offset: number): string; /** * [fn.match] 字符串匹配 * @param source : any * @param cases ：object * @param isExec : boolean = true */ match(source: any, cases: Object, isExec?: boolean): any; /** * [fn.pretty] 转换成格式化字符串 * @param srcObj : any */ pretty(srcObj: any): string; /** * [fn.escape] 编码HTML字符串 * @param srcStr : string */ escape(srcStr: string): string; /** * [fn.unescape] 解码HTML字符串 * @param srcStr : string */ unescape(srcStr: string): string; /** * [fn.capitalize] 字符串首字母大写 * @param srcStr : string */ capitalize(srcStr: string): string; /** * [fn.fmtCurrency] 格式化显示货币 * @param number : number * @param digit : number = 2 */ fmtCurrency(number: number, digit?: number): any; /** * [fn.maskString] 编码字符串或其子串 * @param srcStr : any * @param start : number * @param length : number * @param mask : string = '*' */ maskString(srcStr: any, start: number, length?: number|string, mask?: string): string; /** * [fn.cutString] 裁切字符串到指定长度 * @param srcStr : string * @param length : number */ cutString(srcStr: number, length: number): string; /** * [fn.parseQueryStr] 解析Url参数成对象 * @param url : string */ parseQueryStr(url: string): Object; /** * [fn.stringifyQueryStr] 把对象编译成Url参数 * @param obj : object */ stringifyQueryStr(obj: Object): string; /** * [fn.setPattern]设置一个正则表达式 * @param ptnMap : string|object * @param pattern : regexp [?] */ setPattern(ptnMap: any, pattern?: any): any; /** * [fn.getPattern]获取一个通用的正则表达式 * @param type_ : string * @param limit : boolean = true */ getPattern(type_: string, limit?: boolean): any; /** * [fn.testPattern]用一个或几个通用正则测试 * @param srcStr : string * @param type_ : 'cnChar'|'dbChar'|'email'|'phone'|'telephone'|'idCard'|'uuid'|'base64Code'|'domain'| * 'port'|'ip'|'ipUrl'|'domainUrl'|'url'|'ipWithPortUrl'|'domainWithPortUrl'|'withPortUrl' * @param types : ...string[] * @param limit : boolean = true */ testPattern(srcStr: string, type_: Pattern, ...types: Pattern[]): boolean; /** * [fn.matchPattern]与一个或几个通用正则匹配 * @param srcStr : string * @param type_ : 'cnChar'|'dbChar'|'email'|'mobPhone'|'telPhone'|'idCard'|'uuid'|'base64Code'|'domain'| * 'port'|'ip'|'ipUrl'|'domainUrl'|'url'|'ipWithPortUrl'|'domainWithPortUrl'|'withPortUrl' * @param types : ...string[] * @param limit : boolean = true */ matchPattern(srcStr: string, type_: Pattern, ...types: Pattern[]): any; /** * [fn.rest] 获取函数的剩余参数 * @param func : function */ rest(func: Function): Function; /** * [fn.throttle] 节流函数，适用于限制resize和scroll等函数的调用频率 * @param func : function * @param wait : number * @param options : object [?] * leading: boolean = true * trailing: boolean = true */ throttle(func: Function, wait: number, options?: { leading?: boolean, trailing?: boolean }): Function; /** * [fn.debounce] 防抖函数, 适用于获取用户输入或防止函数频繁调用 * @param func : function * @param wait : number * @param options : object|boolean [?] 为true时，leading = true, trailing = false; * leading: boolean = false * maxing: boolean = false * maxWait: number = Math.max(0, wait) * trailing: boolean = true */ debounce(func: Function, wait: number, options?: boolean | { leading?: boolean, trailing?: boolean, maxing?: boolean, maxWait?: number }): Function; /** * [fn.copyText] 复制文本到粘贴板 * @param text : string */ copyText(text: string): void; /** * [fn.chalk] 返回带颜色的字符串 * @param srcStr : string * @param color : 'grey'|'blue'|'cyan'|'green'|'magenta'|'red'|'yellow' [?] */ chalk(srcStr: string, color?: Color): string; /** * [fn.print] 在控制台打印值 * @param value : any * @param color : 'grey'|'blue'|'cyan'|'green'|'magenta'|'red'|'yellow' [?] */ print(value: any, color?: Color): void; /** * [fn.log] 在控制台打印格式化的值 * @param value : any * @param title : string|boolean [?] * @param configs : object [?] * title: string, * width: number = 66 [30-100], * pre: boolean = false, * end: boolean = false, * breakPre: boolean = false, * breakEnd: boolean = false, * isFmt: boolean = true * isShowTime: boolean = true * ttColor: 'grey'|'blue'|'cyan'|'green'|'magenta'|'red'|'yellow' * color: 'grey'|'blue'|'cyan'|'green'|'magenta'|'red'|'yellow' = 'cyan' */ log(value: any, title?: any, configs?: LogConfig): any; /** * [fn.rd] 读文件 * @param file : string */ rd(file: string): string; /** * [fn.wt] 写文件 * @param file : string * @param text : string * @param flag : 'w'|'a' = 'w' */ wt(file: string, text: string, flag?: 'w' | 'a'): void; /** * [fn.cp] 复制文件或文件夹 * @param src : string * @param dist : string * @param isInner : boolean */ cp(src: string, dist: string, isInner?: boolean): void; /** * [fn.mv] 移动文件或文件夹 * @param src : string * @param dist : string */ mv(src: string, dist: string): void; /** * [fn.rm] 删除文件或文件夹 * @param src : string */ rm(src: string): void; /** * [fn.mk] 创建文件夹 * @param dir : string */ mk(dir: string): void; /** * [fn.size] 获取文件的大小 * @param file : string * @param unit : 'b'|'kb'|'mb'|'gb'|'tb' = 'kb' * @param digit : number = 2 */ size(file: string, unit?: 'b' | 'kb' | 'mb' | 'gb' | 'tb', digit?: number): number; /** * [fn.clear] 命令行清屏 */ clear(): void; /** * [fn.chain] 释放fn变量占用权 */ chain(value?: any): any; /** * [fn.noConflict] 释放fn变量占用权 */ noConflict(): void; } type Any = any; /** * 变量类型 */ type Type = 'arr' | 'obj' | 'fun' | 'str' | 'num' | 'bol' | 'udf' | 'nul' | 'err' | 'reg' | 'dat' | string | string[]; /** * 颜色类型 */ type Color = 'grey' | 'blue' | 'cyan' | 'green' | 'magenta' | 'red' | 'yellow'; /** * 正则类型 */ type Pattern = 'cnChar' | 'dbChar' | 'email' | 'phone' | 'telephone' | 'idCard' | 'uuid' | 'base64Code' | 'domain' | 'port' | 'ip' | 'ipUrl' | 'domainUrl' | 'url' | string; /** * [fn.progress] 进度显示工具 * @param title: string * @param options: object [?] * title: string * width: number = 40 * type : 'bar'|'spi' = 'bar' * isClear : boolean = false * isBreak : boolean = true */ interface Progress { (options: { title?: string, width?: number, type?: 'bar' | 'spi', isClear?: boolean, isBreak?: boolean }): void; (title: string, options?: { width?: number, type?: 'bar' | 'spi', isClear?: boolean, isBreak?: boolean }): void; /** * [fn.progress.start] 暂停进度 */ pause(): void; /** * [fn.progress.start] 开始进度 */ start(): void; /** * [fn.progress.stop] 结束进度条，结束后触发回调 * @param onStopped : function [?] */ stop(onStopped?: Function): void; /** * [fn.progress.stop] 立即结束进度条，并触发回调 * @param onStopped : function [?] */ clear(onStopped?: Function): void; } /** * 定时器 */ interface Timer extends Any { /** * 定时器ID */ id: any; /** * 关闭定时器 */ stop: () => any; /** * 关闭定时器 */ clear: () => any; } /** * 打印配置 */ interface LogConfig { title?: string, width?: number, pre?: boolean, end?: boolean, breakPre: boolean, breakEnd: boolean, isFmt?: boolean, isShowTime?: boolean, color?: 'grey' | 'blue' | 'cyan' | 'green' | 'magenta' | 'red' | 'yellow', ttColor?: 'grey' | 'blue' | 'cyan' | 'green' | 'magenta' | 'red' | 'yellow', } }