xe-utils.d.ts 58 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988
  1. /**
  2. * JavaScript 函数库、工具类
  3. */
  4. declare namespace XEUtils {
  5. export interface SetupDefaults {
  6. /**
  7. * 全局唯一标识
  8. */
  9. keyId?: number
  10. /**
  11. * 默认树的转换配置
  12. * 用于 toArrayTree()、toTreeArray()
  13. */
  14. treeOptions?: {
  15. strict?: boolean;
  16. parentKey?: string;
  17. key?: string;
  18. children?: string;
  19. data?: string;
  20. [key: string]: any;
  21. };
  22. /**
  23. * 默认解析的日期格式
  24. * 用于 toDateString()
  25. */
  26. parseDateFormat?: string;
  27. /**
  28. * 默认格式化日期的规则
  29. * 用于 toDateString()
  30. */
  31. parseDateRules?: ToDateStringFormats;
  32. /**
  33. * 默认周视图的起始天
  34. * 用于 getWhatWeek()、getYearWeek()、toDateString()
  35. */
  36. firstDayOfWeek?: FirstDayOfWeek;
  37. /**
  38. * 分隔函数配置
  39. * 用于 commafy()
  40. */
  41. commafyOptions?: CommafyOptions;
  42. /**
  43. * 已被 parseDateRules 替换
  44. * @deprecated
  45. */
  46. formatStringMatchs?: any;
  47. /**
  48. * 已被 parseDateFormat 替换
  49. * @deprecated
  50. */
  51. formatString?: string;
  52. [key: string]: any;
  53. }
  54. /**
  55. * 版本信息
  56. */
  57. export const version: string
  58. /**
  59. * 设置全局配置
  60. * @param options 全局参数
  61. */
  62. export function setConfig(options: SetupDefaults): SetupDefaults;
  63. /**
  64. * 获取全局配置
  65. */
  66. export function getConfig(): SetupDefaults;
  67. export const VERSION: string
  68. export function setup(options: SetupDefaults): SetupDefaults;
  69. /**
  70. * 将您自己的实用函数扩展到 XEUtils
  71. * @param methods 函数集
  72. */
  73. export function mixin(...methods: {[key: string]: any}[]): void;
  74. /**
  75. * 将一个或多个源对象复制到目标对象中
  76. * @param target 目标对象
  77. * @param source1 要从中复制属性的源对象
  78. */
  79. export function assign<T, U>(target: T, source1: U): T & U;
  80. /**
  81. * 将一个或多个源对象复制到目标对象中
  82. * @param target 目标对象
  83. * @param source1 要从中复制属性的源对象1
  84. * @param source2 要从中复制属性的源对象2
  85. */
  86. export function assign<T, U, V>(target: T, source1: U, source2: V): T & U & V;
  87. /**
  88. * 将一个或多个源对象复制到目标对象中
  89. * @param target 目标对象
  90. * @param source1 要从中复制属性的源对象1
  91. * @param source2 要从中复制属性的源对象2
  92. * @param source3 要从中复制属性的源对象3
  93. */
  94. export function assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
  95. /**
  96. * 将一个或多个源对象复制到目标对象中
  97. * @param target 目标对象
  98. * @param sources 要从中复制属性的一个或多个源对象
  99. */
  100. export function assign(target: any, ...sources: any[]): any;
  101. /**
  102. * 指定方法后的返回值组成的新对象
  103. * @param obj 对象
  104. * @param iterate 回调
  105. * @param context 上下文
  106. */
  107. export function objectMap<T, U>(obj: T, iterate: (item: any, key: string, obj: T) => U, context ?: any): U;
  108. export function objectMap<U>(obj: any, iterate: (item: any, key: string, obj: any) => U, context ?: any): U;
  109. /**
  110. * 对象迭代器
  111. * @param obj 对象
  112. * @param iterate 回调
  113. * @param context 上下文
  114. */
  115. export function objectEach<T>(obj: T, iterate: (item: any, key: string, obj: T) => void, context ?: any): void;
  116. export function objectEach(obj: any, iterate: (item: any, key: string, obj: any) => void, context ?: any): void;
  117. /**
  118. * 对象迭代器,从最后开始迭代
  119. * @param obj 对象
  120. * @param iterate 回调
  121. * @param context 上下文
  122. */
  123. export function lastObjectEach<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => void, context?: C): void;
  124. export function lastObjectEach<C = any>(obj: any, iterate: (this: C, item: any, key: string, obj: any) => void, context?: C): void;
  125. /**
  126. * 将一个或多个源对象合并到目标对象中
  127. * @param target 目标对象
  128. * @param source1 要从中复制属性的源对象1
  129. */
  130. export function merge<T, U>(target: T, source1: U): T & U;
  131. /**
  132. * 将一个或多个源对象合并到目标对象中
  133. * @param target 目标对象
  134. * @param source1 要从中复制属性的源对象1
  135. * @param source2 要从中复制属性的源对象2
  136. */
  137. export function merge<T, U, V>(target: T, source1: U, source2: V): T & U & V;
  138. /**
  139. * 将一个或多个源对象合并到目标对象中
  140. * @param target 目标对象
  141. * @param source1 要从中复制属性的源对象1
  142. * @param source2 要从中复制属性的源对象2
  143. * @param source3 要从中复制属性的源对象3
  144. */
  145. export function merge<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
  146. /**
  147. * 将一个或多个源对象合并到目标对象中
  148. * @param target 目标对象
  149. * @param sources 要从中复制属性的多个源对象
  150. */
  151. export function merge(target: any, ...sources: any[]): any;
  152. /**
  153. * 数组去重
  154. * @param list 数组
  155. * @param iterate 回调/对象属性
  156. * @param context 上下文
  157. */
  158. export function uniq<T, C = any>(list: T[], iterate?: string | number | ((this: C, item: T, index: number, obj: T[]) => string | number), context?: C): T[];
  159. export function uniq<C = any>(list: any, iterate?: string | number | ((this: C, item: any, index: number, obj: any) => string | number), context?: C): any[];
  160. /**
  161. * 将多个数的值返回唯一的并集数组
  162. * @param array 数组
  163. */
  164. export function union(...array: any[]): any[];
  165. /**
  166. * 被 orderBy 替换
  167. * @deprecated
  168. */
  169. export const sortBy: typeof orderBy
  170. interface OrderBySortConfs<T, C> {
  171. field?: string | ((this: C, item: T, index: number, list: T[]) => any) | null;
  172. order?: 'asc' | 'desc' | null;
  173. }
  174. export type OrderByFieldConfs<T, C> = null | string | any[][] | OrderBySortConfs<T, C> | (string | OrderBySortConfs<T, C>)[] | ((this: C, item: T, index: number, list: T[]) => any);
  175. /**
  176. * 将数组进行排序
  177. * @param array 数组
  178. * @param fieldConfs 排序规则
  179. * @param context 上下文
  180. */
  181. export function orderBy<T, C = any>(array: T[], fieldConfs: OrderByFieldConfs<T, C>, context?: C): T[];
  182. /**
  183. * 将一个数组随机打乱,返回一个新的数组
  184. * @param list 数组
  185. */
  186. export function shuffle<T>(list: T[]): T[];
  187. /**
  188. * 从一个数组中随机返回几个元素
  189. * @param array 数组
  190. * @example
  191. */
  192. export function sample<T>(array: T[]): T;
  193. /**
  194. * 从一个数组中随机返回几个元素
  195. * @param array 数组
  196. * @param number 返回个数
  197. * @example
  198. */
  199. export function sample<T>(array: T[], number: number): T[];
  200. /**
  201. * 对象中的值中的每一项运行给定函数,如果函数对任一项返回 true,则返回 true,否则返回 false
  202. * @param list 数组
  203. * @param iterate 回调
  204. * @param context 上下文
  205. */
  206. export function some<T>(list: T[], iterate: (item: T, index: number, list: T[]) => boolean, context?: any): boolean;
  207. /**
  208. * 对象中的值中的每一项运行给定函数,如果该函数对每一项都返回 true,则返回 true,否则返回 false
  209. * @param list 数组
  210. * @param iterate 回调
  211. * @param context 上下文
  212. */
  213. export function every<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[]) => boolean, context?: C): boolean;
  214. /**
  215. * 对象中的值中的每一项运行给定函数,如果该函数对每一项都返回 true,则返回 true,否则返回 false
  216. * @param list 数组
  217. * @param iterate 回调
  218. * @param context 上下文
  219. */
  220. export function every<T, C = any>(list: T, iterate: (this: C, item: any, key: string, list: T) => boolean, context?: C): boolean;
  221. /**
  222. * slice ( array, start, end ) 裁剪 Arguments 或数组 array,从 start 位置开始到 end 结束,但不包括 end 本身的位置
  223. * @param array 对象
  224. * @param start 迭代器/属性
  225. * @param end 上下文
  226. */
  227. export function slice<T>(array: T[], start: number, end?: number): T[];
  228. /**
  229. * 查找匹配第一条数据
  230. * @param array 数组
  231. * @param iterate 回调
  232. * @param context 上下文
  233. */
  234. export function filter<T, C = any>(array: T[], iterate: (this: C, item: T, index: number, list: T[]) => boolean, context?: C): T[];
  235. /**
  236. * 查找匹配第一条数据
  237. * @param obj 数组
  238. * @param iterate 回调
  239. * @param context 上下文
  240. */
  241. export function filter<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, list: T) => boolean, context?: C): any;
  242. /**
  243. * 从左至右遍历,匹配最近的一条数据
  244. * @param array 数组
  245. * @param iterate 回调
  246. * @param context 上下文
  247. */
  248. export function find<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[]) => boolean, context?: C): T;
  249. /**
  250. * 从左至右遍历,匹配最近的一条数据
  251. * @param obj 对象
  252. * @param iterate 回调
  253. * @param context 上下文
  254. */
  255. export function find<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => boolean, context?: C): any;
  256. /**
  257. * 从右至左遍历,匹配最近的一条数据
  258. * @param array 数组
  259. * @param iterate 回调
  260. * @param context 上下文
  261. */
  262. export function findLast<T, C = any>(array: T[], iterate: (this: C, item: T, index: number, list: T[]) => boolean, context?: C): T;
  263. /**
  264. * 从右至左遍历,匹配最近的一条数据
  265. * @param obj 对象
  266. * @param iterate 回调
  267. * @param context 上下文
  268. */
  269. export function findLast<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => boolean, context?: C): any;
  270. /**
  271. * 查找匹配第一条数据的键
  272. * @param list 数组
  273. * @param iterate 回调
  274. * @param context 上下文
  275. */
  276. export function findKey<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[])=> boolean, context?: C): number;
  277. /**
  278. * 查找匹配第一条数据的键
  279. * @param obj 对象
  280. * @param iterate 回调
  281. * @param context 上下文
  282. */
  283. export function findKey<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T)=> boolean, context?: C): any;
  284. /**
  285. * 判断对象是否包含该值,成功返回 true 否则 false
  286. * @param obj 对象
  287. * @param val 值
  288. */
  289. export function includes(obj: any, val: any): boolean;
  290. /**
  291. * 返回数组第一个索引值
  292. * @param list 数组
  293. * @param val 值
  294. */
  295. export function arrayIndexOf<T>(list: ArrayLike<T>, val: any): number;
  296. export function arrayIndexOf(list: any[], val: any): number;
  297. /**
  298. * 从最后开始的索引值,返回数组第一个索引值
  299. * @param list 数组
  300. * @param val 值
  301. */
  302. export function arrayLastIndexOf<T>(list: ArrayLike<T>, val: any): number;
  303. export function arrayLastIndexOf(list: any[], val: any): number;
  304. /**
  305. * 指定方法后的返回值组成的新数组
  306. * @param list 数组
  307. * @param iterate 回调
  308. * @param context 上下文
  309. */
  310. export function map<T, U, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[]) => U, context?: C): U[];
  311. /**
  312. * 接收一个函数作为累加器,数组中的每个值(从左到右)开始合并,最终为一个值
  313. * @param array 数组
  314. * @param iterate 回调
  315. * @param initialValue 默认值
  316. * @example
  317. */
  318. export function reduce<T, U>(array: T[], iterate?: (previous: U, item: T, index: number, list: T[]) => U, initialValue?: U): U;
  319. /**
  320. * 复制数组的一部分到同一数组中的另一个位置,数组大小不变
  321. * @param array 数组
  322. * @param target 从该位置开始替换数据
  323. */
  324. export function copyWithin<T>(array: T[], target: number): T[];
  325. /**
  326. * 复制数组的一部分到同一数组中的另一个位置,数组大小不变
  327. * @param array 数组
  328. * @param target 从该位置开始替换数据
  329. * @param start 从该位置开始读取数据,默认为 0 。如果为负值,表示倒数
  330. * @param end 到该位置前停止读取数据,默认等于数组长度。如果为负值,表示倒数
  331. */
  332. export function copyWithin<T>(array: T[], target: number, start: Number, end?: number): T[];
  333. /**
  334. * 将一个数组分割成大小的组。如果数组不能被平均分配,那么最后一块将是剩下的元素
  335. * @param array 数组
  336. * @param size 每组大小
  337. */
  338. export function chunk<T>(array: T[] | undefined, size: number): T[][];
  339. /**
  340. * 将每个数组中相应位置的值合并在一起
  341. * @param arrays 多个数组
  342. */
  343. export function zip(...arrays: any[]): any[];
  344. /**
  345. * 与 zip 相反
  346. * @param arrays 数组
  347. */
  348. export function unzip(arrays: any[]): any[];
  349. /**
  350. * 将每个数组中相应位置的值合并在一起
  351. * @param props 键数组
  352. * @param values 值数组
  353. * @example
  354. */
  355. export function zipObject(props: any[], values: any[]): any;
  356. /**
  357. * 将一个多维数组铺平
  358. * @param list 数组
  359. * @param deep 是否深层
  360. */
  361. export function flatten<T>(list: T[][], deep?: boolean): T[];
  362. /**
  363. * 将一个多维数组铺平
  364. * @param list 数组
  365. * @param deep 是否深层
  366. */
  367. export function flatten(list: any[], deep?: boolean): any[];
  368. /**
  369. * 将对象或者伪数组转为新数组
  370. * @param list 对象/数组
  371. */
  372. export function toArray<T>(list: T[]): T[];
  373. export function toArray(list: any): any[];
  374. /**
  375. * 判断数组是否包含另一数组
  376. * @param array1 数组
  377. * @param array2 数组
  378. */
  379. export function includeArrays(array1: any[], array2: any[]): boolean;
  380. /**
  381. * 获取数组对象中某属性值,返回一个数组
  382. * @param array 数组
  383. * @param key 键
  384. * @example
  385. */
  386. export function pluck(array: any[], key: string | number): any[];
  387. /**
  388. * 在list的每个元素上执行方法,任何传递的额外参数都会在调用方法的时候传递给它
  389. * @param list 数组
  390. * @param path
  391. * @example
  392. */
  393. export function invoke(list: any[], path: string[] | string | ((this: any, ...args: any[]) => any)): any[];
  394. /**
  395. * 数组迭代器
  396. * @param list 对象
  397. * @param iterate 回调
  398. * @param context 上下文
  399. */
  400. export function arrayEach<T, C = any>(list: T[] | ArrayLike<T>, iterate: (this: C, item: T, index: number, list: T[]) => void, context?: C): void;
  401. export function arrayEach<C = any>(obj: any[], iterate: (this: C, item: any, index: number, obj: any) => void, context?: C): void;
  402. /**
  403. * 数组迭代器,从最后开始迭代
  404. * @param list 对象
  405. * @param iterate 回调
  406. * @param context 上下文
  407. */
  408. export function lastArrayEach<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[]) => void, context?: C): void;
  409. export function lastArrayEach<T, C = any>(list: T, iterate: (this: C, item: any, index: number, list: T) => void, context?: C): void;
  410. export function lastArrayEach<C = any>(list: any[], iterate: (this: C, item: any, index: number, list: any[]) => void, context?: C): void;
  411. export function lastArrayEach<C = any>(list: any, iterate: (this: C, item: any, index: number, list: any) => void, context?: C): void;
  412. export interface ToArrayTreeOptions<T> {
  413. strict?: boolean;
  414. key?: string;
  415. parentKey?: string;
  416. children?: string;
  417. mapChildren?: string;
  418. sortKey?: OrderByFieldConfs<T, any>;
  419. data?: string;
  420. /**
  421. * 已废弃,被 sortKey: { ...,order: 'desc' } 替换
  422. * @deprecated
  423. */
  424. reverse?: boolean;
  425. }
  426. /**
  427. * 将一个带层级的数据列表转成树结构
  428. * @param {Array} list 数组
  429. * @param {Object} options {strict: false, parentKey: 'parentId', key: 'id', children: 'children', mapChildren: '', data: 'data'}
  430. */
  431. export function toArrayTree<T>(list: T[], options?: ToArrayTreeOptions<T>): T[];
  432. export function toArrayTree(list: any, options?: ToArrayTreeOptions<any>): any[];
  433. export interface ToTreeArrayOptions {
  434. key?: string;
  435. parentKey?: string;
  436. children?: string;
  437. data?: string;
  438. updated?: boolean
  439. clear?: boolean;
  440. }
  441. /**
  442. * 将一个树结构转成数组列表
  443. * @param {Array} list 数组
  444. * @param {Object} options { key: 'id', parentKey: 'parentId', children: 'children', data: 'data', clear: false }
  445. */
  446. export function toTreeArray<T>(list: T[], options?: ToTreeArrayOptions): T[];
  447. export function toTreeArray(list: any, options?: ToTreeArrayOptions): any[];
  448. export interface FindTerrResult<T = any> {
  449. index: number;
  450. item: T;
  451. path: Array<string>;
  452. items: T[];
  453. parent: T;
  454. nodes: T[];
  455. }
  456. export interface FindTreeOptions {
  457. children?: string;
  458. }
  459. /**
  460. * 从树结构中查找匹配第一条数据的键、值、路径
  461. * @param {Object} list 数组
  462. * @param {Function} iterate(item, index, items, path, parent, nodes) 回调
  463. * @param {Object} options {children: 'children'}
  464. * @param {Object} context 上下文
  465. */
  466. export function findTree<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, items: T[], path: string[], parent: T, nodes: T[]) => boolean, options?: FindTreeOptions, context?: C): FindTerrResult<T>;
  467. export interface EachTreeOptions {
  468. children?: string;
  469. }
  470. /**
  471. * 从树结构中遍历数据的键、值、路径
  472. * @param {Object} list 数组
  473. * @param {Function} iterate(item, index, items, path, parent, nodes) 回调
  474. * @param {Object} options {children: 'children'}
  475. * @param {Object} context 上下文
  476. */
  477. export function eachTree<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, items: T[], path: string[], parent: T, nodes: T[]) => void, options?: EachTreeOptions, context?: C): void;
  478. export function eachTree<C = any>(list: any[], iterate: (this: C, item: any, index: number, items: any[], path: string[], parent: any, nodes: any[]) => void, options?: EachTreeOptions, context?: C): void;
  479. export function eachTree<C = any>(list: any, iterate: (this: C, item: any, index: number, items: any, path: string[], parent: any, nodes: any) => void, options?: EachTreeOptions, context?: C): void;
  480. export interface MapTreeOptions {
  481. children?: string;
  482. mapChildren?: string;
  483. }
  484. /**
  485. * 从树结构中指定方法后的返回值组成的新数组
  486. * @param {Object} obj 对象/数组
  487. * @param {Function} iterate(item, index, items, path, parent, nodes) 回调
  488. * @param {Object} options {children: 'children', mapChildren: 'children}
  489. * @param {Object} context 上下文
  490. */
  491. export function mapTree<T, U, C = any>(array: T[], iterate: (this: C, item: T, index: number, items: T[], path: string[], parent: T, nodes: T[]) => U, options?: MapTreeOptions, context?: C): U[];
  492. export function mapTree<U, C = any>(array: any[], iterate: (this: C, item: any, index: number, items: any[], path: string[], parent: any, nodes: any[]) => U, options?: MapTreeOptions, context?: C): U[];
  493. export function mapTree<U, C = any>(array: any, iterate: (this: C, item: any, index: number, items: any, path: string[], parent: any, nodes: any) => U, options?: MapTreeOptions, context?: C): U[];
  494. export interface FilterTreeOptions {
  495. children?: string;
  496. }
  497. /**
  498. * 从树结构中根据回调过滤数据
  499. * @param {Object} list 数组
  500. * @param {Function} iterate(item, index, items, path, parent) 回调
  501. * @param {Object} options {children: 'children'}
  502. * @param {Object} context 上下文
  503. */
  504. export function filterTree<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, items: T[], path: string[], parent: T, nodes: T[]) => boolean, options?: FilterTreeOptions, context?: C): T[];
  505. export interface SearchTreeOptions {
  506. isEvery?: boolean
  507. children?: string;
  508. mapChildren?: string;
  509. original?: boolean;
  510. data?: string;
  511. }
  512. /**
  513. * 从树结构中根据回调查找数据
  514. * @param {Object} list 对象/数组
  515. * @param {Function} iterate(item, index, items, path, parent, nodes) 回调
  516. * @param {Object} options {children: 'children'}
  517. * @param {Object} context 上下文
  518. */
  519. export function searchTree<T>(list: T[], iterate: (item: T, index: number, items: T[], path: string[], parent: T, nodes: T[]) => boolean, options?: SearchTreeOptions, context?: any): T[];
  520. export function searchTree(list: any[], iterate: (item: any, index: number, items: any[], path: string[], parent: any, nodes: any[]) => boolean, options?: SearchTreeOptions, context?: any): any[];
  521. export function searchTree(list: any, iterate: (item: any, index: number, items: any, path: string, parent: any, nodes: any) => boolean, options?: SearchTreeOptions, context?: any): any[];
  522. /**
  523. * 判断对象自身属性中是否具有指定的属性
  524. * @param obj 对象
  525. * @param key 键值
  526. */
  527. export function hasOwnProp(obj: any, key: string | number): boolean;
  528. /**
  529. * 判断是否 undefined 和 null
  530. * @param obj 对象
  531. */
  532. export function eqNull(obj: any): boolean;
  533. /**
  534. * 判断是否非数值
  535. * @param val 值
  536. */
  537. export function isNaN(val: any): boolean;
  538. /**
  539. * 判断是否为有限数值
  540. * @param val 值
  541. */
  542. export function isFinite(val: any): val is number;
  543. /**
  544. * 判断 Undefined
  545. * @param val 值
  546. */
  547. export function isUndefined(val: any): val is undefined;
  548. /**
  549. * 判断是否数组
  550. * @param val 值
  551. */
  552. export function isArray(val: any): val is any[];
  553. /**
  554. * 判断是否小数
  555. * @param val 值
  556. */
  557. export function isFloat(val: any): val is number;
  558. /**
  559. * 判断是否整数
  560. * @param val 值
  561. */
  562. export function isInteger(val: any): val is number;
  563. /**
  564. * 判断是否方法
  565. * @param val 值
  566. */
  567. export function isFunction(val: any): val is Function;
  568. /**
  569. * 判断是否 Boolean 对象
  570. * @param val 值
  571. */
  572. export function isBoolean(val: any): val is boolean;
  573. /**
  574. * 判断是否String对象
  575. * @param val 值
  576. */
  577. export function isString(val: any): val is string;
  578. /**
  579. * 判断是否 Number 对象
  580. * @param val 值
  581. */
  582. export function isNumber(val: any): val is number;
  583. /**
  584. * 判断是否 RegExp 对象
  585. * @param val 值
  586. */
  587. export function isRegExp(val: any): val is RegExp;
  588. /**
  589. * 判断是否 Object 对象
  590. * @param val 值
  591. */
  592. export function isObject(val: any): val is object;
  593. /**
  594. * 判断是否是一个对象
  595. * @param val 值
  596. */
  597. export function isPlainObject(val: any): val is object;
  598. /**
  599. * 判断是否 Date 对象
  600. * @param val 值
  601. */
  602. export function isDate(val: any): val is Date;
  603. /**
  604. * 判断是否 Error 对象
  605. * @param val 值
  606. */
  607. export function isError(val: any): val is Error;
  608. /**
  609. * 判断是否 TypeError 对象
  610. * @param val 值
  611. */
  612. export function isTypeError(val: any): val is TypeError;
  613. /**
  614. * 判断是否为空对象
  615. * @param val 值
  616. */
  617. export function isEmpty(val: any): boolean;
  618. /**
  619. * 判断是否为 Null
  620. * @param val 值
  621. */
  622. export function isNull(val: any): val is null;
  623. /**
  624. * 判断是否 Symbol 对象
  625. * @param val 值
  626. */
  627. export function isSymbol(val: any): val is symbol;
  628. /**
  629. * 判断是否 Arguments 对象
  630. * @param val 值
  631. */
  632. export function isArguments(val: any): val is IArguments;
  633. /**
  634. * 判断是否 Element 对象
  635. * @param val 值
  636. */
  637. export function isElement(val: any): val is Element;
  638. /**
  639. * 判断是否 Document 对象
  640. * @param val 值
  641. */
  642. export function isDocument(val: any): val is Document;
  643. /**
  644. * 判断是否 Window 对象
  645. * @param val 值
  646. */
  647. export function isWindow(val: any): val is Window;
  648. /**
  649. * 判断是否 FormData 对象
  650. * @param val 值
  651. */
  652. export function isFormData(val: any): val is FormData;
  653. /**
  654. * 判断是否 Map 对象
  655. * @param val 值
  656. */
  657. export function isMap(val: any): val is Map<any, any>;
  658. /**
  659. * 判断是否 WeakMap 对象
  660. * @param val 值
  661. */
  662. export function isWeakMap(val: any): val is WeakMap<any, any>;
  663. /**
  664. * 判断是否 Set 对象
  665. * @param val 值
  666. */
  667. export function isSet(val: any): val is Set<any>;
  668. /**
  669. * 判断是否 WeakSet 对象
  670. * @param val 值
  671. */
  672. export function isWeakSet(val: any): val is WeakSet<any>;
  673. /**
  674. * 判断是否闰年
  675. * @param date 日期
  676. */
  677. export function isLeapYear(date: Date | number | string): boolean;
  678. export function isLeapYear(date: any): boolean;
  679. /**
  680. * 判断属性中的键和值是否包含在对象中
  681. * @param obj 对象
  682. * @param source 值
  683. */
  684. export function isMatch(obj: any, source: any): boolean;
  685. /**
  686. * 深度比较两个对象之间的值是否相等
  687. * @param obj1 值1
  688. * @param obj2 值2
  689. */
  690. export function isEqual(obj1: any, obj2: any): boolean;
  691. /**
  692. * 深度比较两个对象之间的值是否相等,使用自定义比较函数
  693. * @param obj1 值1
  694. * @param obj2 值2
  695. */
  696. export function isEqualWith(obj1: any, obj2: any): boolean;
  697. /**
  698. * 深度比较两个对象之间的值是否相等,使用自定义比较函数
  699. * @param obj1 值1
  700. * @param obj2 值2
  701. * @param func 自定义函数
  702. */
  703. export function isEqualWith<T, U>(obj1: T, obj2: U, func: (val1: any, val2: any, key: any, obj1: T, obj2: U) => any): boolean;
  704. /**
  705. * 获取对象类型
  706. * @param obj 对象
  707. */
  708. export function getType(obj: any): string;
  709. /**
  710. * 获取一个全局唯一标识
  711. * @param prefix 自定义前缀
  712. */
  713. export function uniqueId(prefix?: string | number | null): string;
  714. /**
  715. * 返回对象的长度
  716. * @param obj 对象
  717. */
  718. export function getSize(obj: any): number;
  719. /**
  720. * 返回对象第一个索引值
  721. * @param obj 对象
  722. * @param val 值
  723. */
  724. export function indexOf(obj: any, val: any): number;
  725. /**
  726. * 从最后开始的索引值,返回对象第一个索引值
  727. * @param obj 对象
  728. * @param val 值
  729. */
  730. export function lastIndexOf(obj: any[], val: any): number;
  731. export function lastIndexOf(obj: any, val: any): number;
  732. /**
  733. * 返回对象第一个索引值
  734. * @param list 数组
  735. * @param iterate 迭代器
  736. * @param context 上下文
  737. */
  738. export function findIndexOf<T, C = any>(list: T[], iterate: (this: C, item: T, index: any, obj: T[]) => boolean, context?: C): number;
  739. /**
  740. * 返回对象第一个索引值
  741. * @param obj 对象
  742. * @param iterate 迭代器
  743. * @param context 上下文
  744. */
  745. export function findIndexOf<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => boolean, context?: C): number;
  746. /**
  747. * 从最后开始的索引值,返回对象第一个索引值
  748. * @param list 数组
  749. * @param iterate 迭代器
  750. * @param context 上下文
  751. */
  752. export function findLastIndexOf<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T[]) => boolean, context?: C): number;
  753. /**
  754. * 从最后开始的索引值,返回对象第一个索引值
  755. * @param obj 对象
  756. * @param iterate 迭代器
  757. * @param context 上下文
  758. */
  759. export function findLastIndexOf<C = any>(obj: any, iterate: (this: C, item: any, key: string, obj: any) => boolean, context?: C): number;
  760. /**
  761. * 字符串转 JSON
  762. * @param str 字符串
  763. */
  764. export function toStringJSON(str: string | null): any;
  765. export function toStringJSON(str: any): any;
  766. /**
  767. * JSON 转字符串
  768. * @param obj 对象
  769. */
  770. export function toJSONString(obj: any): string;
  771. /**
  772. * 获取对象所有属性
  773. * @param obj 对象
  774. */
  775. export function keys(obj: any): string[];
  776. /**
  777. * 获取对象所有值
  778. * @param obj 对象
  779. */
  780. export function values<T>(obj: { [s: string]: T } | T[]): T[];
  781. export function values(obj: any): any[];
  782. /**
  783. * 获取对象所有属性、值
  784. * @param obj 对象
  785. */
  786. export function entries(obj: any): any[];
  787. /**
  788. * 根据 keys 过滤指定的属性值,返回一个新的对象
  789. * @param obj 对象
  790. * @param array 数组或字符串或方法
  791. */
  792. export function pick(obj: any, array: string[]): any;
  793. /**
  794. * 根据 keys 排除指定的属性值,返回一个新的对象
  795. * @param obj 对象
  796. * @param array 数组或字符串或方法
  797. */
  798. export function omit(obj: any, array: string[]): any;
  799. /**
  800. * 获取对象第一个值
  801. * @param list 数组
  802. */
  803. export function first<T>(list: T[] | ArrayLike<T>): T;
  804. export function first(obj: any): any;
  805. /**
  806. * 获取对象最后一个值
  807. * @param list 数组
  808. */
  809. export function last<T>(list: T[] | ArrayLike<T>): T;
  810. /**
  811. * 获取对象最后一个值
  812. * @param obj 对象
  813. */
  814. export function last(obj: any): any;
  815. /**
  816. * 通用迭代器
  817. * @param list 对象
  818. * @param iterate 回调
  819. * @param context 上下文
  820. */
  821. export function each<T, C = any>(list: T[] | ArrayLike<T>, iterate: (this: C, item: T, index: number, list: T[]) => void, context?: CSSKeyframeRule): void;
  822. /**
  823. * 通用迭代器
  824. * @param obj 对象
  825. * @param iterate 回调
  826. * @param context 上下文
  827. */
  828. export function each<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => void, context?: C): void;
  829. /**
  830. * 已废弃,被 some, every 替换
  831. * @deprecated
  832. */
  833. export function forOf<C = any>(obj: any, iterate: (this: C, item: any, index: any, obj: any) => boolean, context?: C): void;
  834. /**
  835. * 已废弃
  836. * @deprecated
  837. */
  838. export function lastForOf<C = any>(obj: any, iterate: (this: C, item: any, index: any, obj: any) => boolean, context?: C): void;
  839. /**
  840. * 通用迭代器,从最后开始迭代
  841. * @param list 对象
  842. * @param iterate 回调
  843. * @param context 上下文
  844. */
  845. export function lastEach<T, C = any>(list: T[], iterate: (this: C, item: T, index: number, list: T) => void, context?: C): void;
  846. export function lastEach<T, C = any>(obj: T, iterate: (this: C, item: any, key: string, obj: T) => void, context?: C): void;
  847. export function lastEach<C = any>(obj: any[], iterate: (this: C, item: any, key: string, obj: any[]) => void, context?: C): void;
  848. export function lastEach<C = any>(obj: any, iterate: (this: C, item: any, key: string, obj: any) => void, context?: C): void;
  849. /**
  850. * 检查键、路径是否是该对象的属性
  851. * @param obj 对象
  852. * @param property 键、路径
  853. */
  854. export function has(obj: any, property: undefined | null | number | number[] | string | string[]): boolean;
  855. /**
  856. * 获取对象的属性的值,如果值为 undefined,则返回默认值
  857. * @param obj 对象
  858. * @param property 键、路径
  859. * @param defaultValue 默认值
  860. */
  861. export function get<T extends object, K extends keyof T>(obj: T, property: undefined | null | number | number[] | string | string[], defaultValue?: any): T[K];
  862. export function get(obj: any, property: undefined | null | number | number[] | string | string[], defaultValue?: any): any;
  863. /**
  864. * 设置对象属性上的值。如果属性不存在则创建它
  865. * @param obj 对象
  866. * @param property 键、路径
  867. * @param value 值
  868. */
  869. export function set(obj: any, property: string | string[], value: any): any;
  870. /**
  871. * 集合分组,默认使用键值分组,如果有 iterate 则使用结果进行分组
  872. * @param list 对象
  873. * @param iterate 回调/对象属性
  874. * @param context 上下文
  875. */
  876. export function groupBy<T, C = any>(list: T[], iterate: string | number | ((this: C, item: T, index: number, obj: T[]) => string | number), context?: C): { [key: string]: T[] };
  877. /**
  878. * 集合分组,默认使用键值分组,如果有 iterate 则使用结果进行分组
  879. * @param obj 对象
  880. * @param iterate 回调/对象属性
  881. * @param context 上下文
  882. */
  883. export function groupBy<T, C = any>(obj: T, iterate: string | number | ((this: C, item: any, key: string, obj: T) => string | number), context?: C): { [key: string]: any[] };
  884. /**
  885. * 集合分组统计,返回各组中对象的数量统计
  886. * @param list 对象
  887. * @param iterate 回调/属性
  888. * @param context 上下文
  889. */
  890. export function countBy<T, C = any>(list: T[], iterate: string | number | ((this: C, item: T, index: number, list: T[]) => string | number), context?: C): { [key: string]: number };
  891. /**
  892. * 集合分组统计,返回各组中对象的数量统计
  893. * @param obj 对象
  894. * @param iterate 回调/属性
  895. * @param context 上下文
  896. */
  897. export function countBy<T, C = any>(obj: T, iterate: string | number | ((this: C, item: any, key: string, obj: T) => string | number), context?: C): { [key: string]: number };
  898. /**
  899. * 浅拷贝/深拷贝
  900. * @param obj 对象
  901. */
  902. export function clone<T>(obj: T): T;
  903. /**
  904. * 浅拷贝/深拷贝
  905. * @param obj 对象
  906. * @param deep 是否深拷贝
  907. */
  908. export function clone<T>(obj: T, deep: boolean): T;
  909. /**
  910. * 清空对象; defs如果不传(清空所有属性)、如果传对象(清空并继承)、如果传值(给所有赋值)
  911. * @param obj 对象
  912. */
  913. export function clear<T>(obj: T): T;
  914. /**
  915. * 清空对象; defs如果不传(清空所有属性)、如果传对象(清空并继承)、如果传值(给所有赋值)
  916. * @param obj 对象
  917. * @param defs 默认值
  918. */
  919. export function clear<T>(obj: T, defs: any): T;
  920. /**
  921. * 清空对象; defs如果不传(清空所有属性)、如果传对象(清空并继承)、如果传值(给所有赋值)
  922. * @param obj 对象
  923. * @param defs 默认值
  924. * @param assigns 值
  925. */
  926. export function clear<T, U>(obj: T, defs: any, assigns: U): T & U;
  927. /**
  928. * 移除对象属性
  929. * @param list 对象
  930. * @param iterate 迭代器/值
  931. */
  932. export function remove<T, C>(list: T[], iterate: number | string | ((this: C, item: T, index: number, list: T[]) => boolean), context?: C): T[];
  933. /**
  934. * 移除对象属性
  935. * @param obj 对象
  936. * @param iterate 迭代器/值
  937. */
  938. export function remove<C>(obj: any, iterate: number | string | ((this: C, item: any, key: string, obj: any) => boolean), context?: C): any;
  939. /**
  940. * 序号列表生成函数
  941. * @param start 起始值
  942. * @param stop 结束值
  943. */
  944. export function range(start: number, stop: number): number[];
  945. /**
  946. * 序号列表生成函数
  947. * @param start 起始值
  948. * @param stop 结束值
  949. * @param step 自增值
  950. */
  951. export function range(start: number, stop: number, step: number): number[];
  952. /**
  953. * 将一个或者多个对象值解构到目标对象
  954. * @param obj 对象
  955. * @param target 目标
  956. */
  957. export function destructuring<T>(obj: T, ...target: any[]): T;
  958. /**
  959. * 获取一个指定范围内随机数
  960. * @param min 最小值
  961. * @param max 最大值
  962. */
  963. export function random(min: number, max: number): number;
  964. /**
  965. * 获取最小值
  966. * @param array 数组
  967. * @param iterate 回调/属性
  968. */
  969. export function min<T>(list: T[], iterate?: string | number | ((item: T, index: number, list: T[]) => number | string)): T | null | undefined;
  970. /**
  971. * 获取最大值
  972. * @param list 数组
  973. * @param iterate 回调/属性
  974. */
  975. export function max<T>(list: T[], iterate?: string | number | ((item: T, index: number, list: T[]) => number | string)): T | null | undefined;
  976. export interface CommafyOptions {
  977. /**
  978. * 分割位数,默认3
  979. */
  980. spaceNumber?: number;
  981. /**
  982. * 分隔符,默认','
  983. */
  984. separator?: string;
  985. /**
  986. * 只对 number 类型有效,小数位数,默认null
  987. */
  988. digits?: number;
  989. /**
  990. * 只对 number 类型有效,四舍五入,默认true
  991. */
  992. round?: boolean;
  993. /**
  994. * 只对 number 类型有效,向上舍入
  995. */
  996. ceil?: boolean;
  997. /**
  998. * 只对 number 类型有效,向下舍入
  999. */
  1000. floor?: boolean;
  1001. }
  1002. /**
  1003. * 数值千分位分隔符、小数点
  1004. * @param num 数值/字符串
  1005. * @param options 可选参数
  1006. */
  1007. export function commafy(num: string | number, options?: CommafyOptions): string;
  1008. /**
  1009. * 对数字进行四舍五入
  1010. * @param num 数值/字符串
  1011. * @param digits 小数保留位数
  1012. */
  1013. export function round(num: number, digits?: number): number;
  1014. export function round(num: any, digits?: number): number;
  1015. /**
  1016. * 将数值向上舍入
  1017. * @param num 数值/字符串
  1018. */
  1019. export function ceil(num: string | number): number;
  1020. /**
  1021. * 将数值向上舍入
  1022. * @param num 数值/字符串
  1023. * @param digits 小数保留位数
  1024. */
  1025. export function ceil(num: string | number, digits: number): number;
  1026. /**
  1027. * 将数值向下舍入
  1028. * @param num 数值/字符串
  1029. * @param digits 小数保留位数
  1030. */
  1031. export function floor(num: string | number, digits?: number): number;
  1032. /**
  1033. * 将数值四舍五入并格式化为固定小数位的字符串
  1034. * @param num 数值/字符串
  1035. * @param digits 小数保留位数
  1036. */
  1037. export function toFixed(num: number | string | null, digits?: number): string;
  1038. export function toFixed(num: any, digits?: number): string;
  1039. /**
  1040. * 转数值
  1041. * @param num 数值/字符串
  1042. */
  1043. export function toNumber(num: number | string | null): number;
  1044. export function toNumber(num: any): number;
  1045. /**
  1046. * 数值转字符串,科学计数转字符串
  1047. * @param num 数值
  1048. */
  1049. export function toNumberString(num: number | string | null): string;
  1050. export function toNumberString(num: any): string;
  1051. /**
  1052. * 转整数
  1053. * @param num 数值/字符串
  1054. */
  1055. export function toInteger(num: number | string | null): number;
  1056. export function toInteger(num: any): number;
  1057. /**
  1058. * 加法运算
  1059. * @param num1 数值1
  1060. * @param num2 数值2
  1061. */
  1062. export function add(num1: number, num2: number): number;
  1063. /**
  1064. * 减法运算
  1065. * @param num1 数值1
  1066. * @param num2 数值2
  1067. */
  1068. export function subtract(num1: number, num2: number): number;
  1069. export function subtract(num1: any, num2: any): number;
  1070. /**
  1071. * 乘法运算
  1072. * @param num1 数值1
  1073. * @param num2 数值2
  1074. */
  1075. export function multiply(num1: number, num2: number): number;
  1076. export function multiply(num1: any, num2: any): number;
  1077. /**
  1078. * 除法运算
  1079. * @param num1 数值1
  1080. * @param num2 数值2
  1081. */
  1082. export function divide(num1: number, num2: number): number;
  1083. /**
  1084. * 求和函数,将数值相加
  1085. * @param obj 对象/数组
  1086. * @param iterate 回调
  1087. * @param context 上下文
  1088. */
  1089. export function sum<T, C = any>(obj: T[], iterate?: string | number | ((this: C, item: T, index: number, list: T[]) => number), context?: C): number;
  1090. /**
  1091. * 求平均值函数
  1092. * @param array 对象/数组
  1093. * @param iterate 回调
  1094. * @param context 上下文
  1095. */
  1096. export function mean<T>(obj: T[], iterate?: string | number | ((item: T, index: number, list: T[]) => any), context?: any): number;
  1097. /**
  1098. * 返回当前时间戳
  1099. */
  1100. export function now(): number;
  1101. /**
  1102. * 将日期转为时间戳
  1103. * @param date 字符串/日期/时间戳
  1104. * @param format 解析格式 yyyy MM dd HH mm ss SSS
  1105. */
  1106. export function timestamp(date: string | Date | number, format?: string | null): number;
  1107. export function timestamp(date: any, format?: string | null): number;
  1108. /**
  1109. * 判断是否有效的Date对象
  1110. * @param val 值
  1111. */
  1112. export function isValidDate(val: any): val is Date;
  1113. /**
  1114. * 判断两个日期是否相同
  1115. * @param date1 日期
  1116. * @param date2 日期
  1117. * @param format 对比格式
  1118. */
  1119. export function isDateSame(date1: Date | number | string, date2: Date | number | string, format?: string | null): boolean;
  1120. export function isDateSame(date1: any, date2: any, format?: string | null): boolean;
  1121. /**
  1122. * 任意格式字符串转为日期
  1123. * @param str 字符串/日期/时间戳
  1124. */
  1125. export function toStringDate(str: string | Date | number | null): Date;
  1126. export function toStringDate(str: any): Date;
  1127. /**
  1128. * 任意格式字符串转为日期
  1129. * @param str 字符串/日期/时间戳
  1130. * @param format 解析格式 yyyy MM dd HH mm ss SSS
  1131. */
  1132. export function toStringDate(str: string | Date | number | null, format: string | null): Date;
  1133. export function toStringDate(str: any, format: string | null): Date;
  1134. export type ToDateStringFormats = {
  1135. /**
  1136. * 用于格式化季度
  1137. * 例如:[null, '第一季度', '第二季度', '第三季度', '第四季度']
  1138. */
  1139. q?: string[] | {
  1140. 1: string
  1141. 2: string
  1142. 3: string
  1143. 4: string
  1144. } | ((value: string | number, match: string, date: Date) => string);
  1145. /**
  1146. * 用于格式化周
  1147. * 例如:['日', '一', '二', '三', '四', '五', '六']
  1148. */
  1149. E?: string[] | {
  1150. 0: string
  1151. 1: string
  1152. 2: string
  1153. 3: string
  1154. 4: string
  1155. 5: string
  1156. 6: string
  1157. } | ((value: string | number, match: string, date: Date) => string);
  1158. }
  1159. export interface ToDateStringOptions {
  1160. /**
  1161. * 默认周视图的起始天
  1162. */
  1163. firstDay?: FirstDayOfWeek;
  1164. /**
  1165. * 自定义格式化模板
  1166. */
  1167. formats?: ToDateStringFormats
  1168. }
  1169. /**
  1170. * 日期格式化为任意格式字符串,转义符号 []
  1171. * @param date 字符串/日期/时间戳
  1172. */
  1173. export function toDateString(date: string | Date | number): string;
  1174. export function toDateString(date: any): string;
  1175. /**
  1176. * 日期格式化为任意格式字符串,转义符号 []
  1177. * @param date 字符串/日期/时间戳
  1178. * @param format 格式化 默认:yyyy-MM-dd HH:mm:ss.SSS
  1179. */
  1180. export function toDateString(date: string | Date | number, format: string | null): string;
  1181. export function toDateString(date: any, format: string | null): string;
  1182. /**
  1183. * 日期格式化为任意格式字符串,转义符号 []
  1184. * @param date 字符串/日期/时间戳
  1185. * @param format 格式化 默认:yyyy-MM-dd HH:mm:ss.SSS
  1186. * @param options 可选参数
  1187. */
  1188. export function toDateString(date: string | Date | number, format: string | null, options: ToDateStringOptions): string;
  1189. export function toDateString(date: any, format: string | null, options: ToDateStringOptions): string;
  1190. /**
  1191. * 返回前几年或后几年的日期
  1192. * @param date 字符串/日期/时间戳
  1193. * @param year 年(默认当前年)、前几个年(数值)、后几个年(数值)
  1194. */
  1195. export function getWhatYear(date: string | Date | number, offset: number): Date;
  1196. /**
  1197. * 返回前几年或后几年的日期,可以指定年初(first)、年末(last)、月份(0~11),默认当前
  1198. * @param date 字符串/日期/时间戳
  1199. * @param year 年(默认当前年)、前几个年(数值)、后几个年(数值)
  1200. * @param month 获取哪月:年初(first)、年末(last)、指定月份(0-11)
  1201. */
  1202. export function getWhatYear(date: string | Date | number, offset: number, month: number | 'first' | 'last'): Date;
  1203. /**
  1204. * 返回前几季度或后几季度的日期
  1205. * @param date 字符串/日期/时间戳
  1206. * @param offset 季度偏移量(默认0)、前几个季度、后几个季度
  1207. */
  1208. export function getWhatQuarter(date: string | Date | number, offset: number): Date;
  1209. /**
  1210. * 返回前几季度或后几季度的日期,可以指定月初(first)、月末(last)、天数,默认当前
  1211. * @param date 字符串/日期/时间戳
  1212. * @param offset 季度偏移量(默认当前季度)、前几个季度、后几个季度
  1213. * @param day 获取哪天:月初(first)、月末(last)、指定天数(数值)
  1214. */
  1215. export function getWhatQuarter(date: string | Date | number, offset: number, day: number | 'first' | 'last'): Date;
  1216. /**
  1217. * 返回前几月或后几月的日期
  1218. * @param date 字符串/日期/时间戳
  1219. * @param offsetMonth 月偏移量(默认0)、前几个月、后几个月
  1220. */
  1221. export function getWhatMonth(date: string | Date | number, offset: number): Date;
  1222. /**
  1223. * 返回前几月或后几月的日期,可以指定月初(first)、月末(last)、天数,默认当前
  1224. * @param date 字符串/日期/时间戳
  1225. * @param offsetMonth 月偏移量(默认默认当前月)、前几个月、后几个月
  1226. * @param offsetDay 获取哪天:月初(first)、月末(last)、指定天数(数值)
  1227. */
  1228. export function getWhatMonth(date: string | Date | number, offset: number, day: number | 'first' | 'last'): Date;
  1229. export type FirstDayOfWeek = 0 | 1 | 2 | 3 | 4 |5 | 6
  1230. /**
  1231. * 返回前几周或后几周的日期
  1232. * @param date 字符串/日期/时间戳
  1233. * @param offsetWeek 周偏移量(默认当前周)、前几周、后几周
  1234. */
  1235. export function getWhatWeek(date: string | Date | number, offsetWeek?: FirstDayOfWeek): Date;
  1236. /**
  1237. * 返回前几周或后几周的日期,可以指定星期几(0~6),默认当前
  1238. * @param date 字符串/日期/时间戳
  1239. * @param offsetWeek 获取周偏移量(默认0当前周、前几周、后几周)
  1240. * @param offsetDay 获取星期几(星期天0、星期一1、星期二2、星期三3、星期四4、星期五5、星期六6)
  1241. * @param firstDay 周视图的起始天,默认星期一
  1242. */
  1243. export function getWhatWeek(date: string | Date | number, offsetWeek?: number, offsetDay?: FirstDayOfWeek, firstDay?: FirstDayOfWeek): Date;
  1244. /**
  1245. * 返回前几天或后几天的日期
  1246. * @param date 字符串/日期/时间戳
  1247. * @param offset 天偏移量(默认0)、前几天、后几天
  1248. */
  1249. export function getWhatDay(date: string | Date | number, offset: number): Date;
  1250. /**
  1251. * 返回前几天或后几天的日期
  1252. * @param date 字符串/日期/时间戳
  1253. * @param offset 天偏移量(默认0)、前几天、后几天
  1254. * @param mode 获取时间:日初(first)、日末(last)
  1255. */
  1256. export function getWhatDay(date: string | Date | number, offset: number, mode: 'first' | 'last'): Date;
  1257. /**
  1258. * 返回某个年份的第几天
  1259. * @param date 字符串/日期/时间戳
  1260. */
  1261. export function getYearDay(date: string | Date | number): number;
  1262. /**
  1263. * 返回某个年份的第几周
  1264. * @param date 字符串/日期/时间戳
  1265. * @param firstDay 从年初的星期几为起始开始周开始算,默认星期一
  1266. */
  1267. export function getYearWeek(date: string | Date | number, firstDay?: FirstDayOfWeek): number;
  1268. /**
  1269. * 返回某个月份的第几周
  1270. * @param date 字符串/日期/时间戳
  1271. * @param firstDay 周视图的起始天,默认星期一
  1272. */
  1273. export function getMonthWeek(date: string | Date | number, firstDay?: FirstDayOfWeek): number;
  1274. /**
  1275. * 返回某个年份的天数,可以指定前几个年或后几个年,默认当前
  1276. * @param date 字符串/日期/时间戳
  1277. * @param offset 年偏移量(默认0)、前几个年、后几个年
  1278. */
  1279. export function getDayOfYear(date: string | Date | number, offset: number): Date;
  1280. /**
  1281. * 返回某个月份的天数,可以指定前几个月或后几个月,默认当前
  1282. * @param date 字符串/日期/时间戳
  1283. * @param offset 月偏移量(默认0)、前几个月、后几个月
  1284. */
  1285. export function getDayOfMonth(date: string | Date | number, offset: number): number;
  1286. export interface DateDiffResult {
  1287. /**
  1288. * 是否计算完成(如果结束日期小于开始日期 status 为 fasle)
  1289. */
  1290. status: boolean;
  1291. /**
  1292. * 已废弃,请使用 status
  1293. * @deprecated
  1294. */
  1295. done: boolean;
  1296. /**
  1297. * 相差多少毫秒
  1298. */
  1299. time: Number;
  1300. /**
  1301. * 年
  1302. */
  1303. yyyy: number;
  1304. /**
  1305. * 月
  1306. */
  1307. MM: number;
  1308. /**
  1309. * 日
  1310. */
  1311. dd: number;
  1312. /**
  1313. * 时
  1314. */
  1315. HH: number;
  1316. /**
  1317. * 分
  1318. */
  1319. mm: number;
  1320. /**
  1321. * 秒
  1322. */
  1323. ss: number;
  1324. /**
  1325. * 毫秒
  1326. */
  1327. S: number;
  1328. }
  1329. /**
  1330. * 返回两个日期之间差距,如果结束日期小于开始日期 done 为 fasle
  1331. * @param startDate 开始日期
  1332. * @param endDate 结束日期或当期日期
  1333. */
  1334. export function getDateDiff(startDate: string | Date | number, endDate: string | Date | number): DateDiffResult;
  1335. /**
  1336. * 返回两个日期之间差距,如果结束日期小于开始日期 done 为 fasle
  1337. * @param startDate 开始日期
  1338. * @param endDate 结束日期或当期日期
  1339. */
  1340. export function getDateDiff(startDate: string | Date | number, endDate: string | Date | number): DateDiffResult;
  1341. /**
  1342. * 去除字符串左右两边的空格
  1343. * @param str 字符串
  1344. */
  1345. export function trim(str: string): string;
  1346. export function trim(str: any): string;
  1347. /**
  1348. * 去除字符串左边的空格
  1349. * @param str 字符串
  1350. */
  1351. export function trimLeft(str: string): string;
  1352. export function trimLeft(str: any): string;
  1353. /**
  1354. * 去除字符串右边的空格
  1355. * @param str 字符串
  1356. */
  1357. export function trimRight(str: string): string;
  1358. export function trimRight(str: any): string;
  1359. /**
  1360. * 转义HTML字符串,替换&, <, >, ", ', \`字符
  1361. * @param str 字符串
  1362. */
  1363. export function escape(str: string): string;
  1364. /**
  1365. * 反转 escape
  1366. * @param str 字符串
  1367. */
  1368. export function unescape(str: string): string;
  1369. export function unescape(str: any): string;
  1370. /**
  1371. * 将带字符串转成驼峰字符串,例如: project-name 转为 projectName
  1372. * @param str 字符串
  1373. */
  1374. export function camelCase(str: string): string;
  1375. /**
  1376. * 将带驼峰字符串转成字符串,例如: projectName 转为 project-name
  1377. * @param str 字符串
  1378. */
  1379. export function kebabCase(str: string): string;
  1380. export function kebabCase(str: any): string;
  1381. /**
  1382. * 将字符串重复 n 次
  1383. * @param str 字符串
  1384. * @param count 次数
  1385. */
  1386. export function repeat(str: string, count: number): string;
  1387. export function repeat(str: any, count: number): string;
  1388. /**
  1389. * 用指定字符从前面开始补全字符串
  1390. * @param str 字符串
  1391. * @param targetLength 结果长度
  1392. * @param padString 补全字符
  1393. */
  1394. export function padStart(str: string, targetLength: number, padString?: string): string;
  1395. export function padStart(str: any, targetLength: number, padString?: any): string;
  1396. /**
  1397. * 用指定字符从后面开始补全字符串
  1398. * @param str 字符串
  1399. * @param targetLength 结果长度
  1400. * @param padString 补全字符
  1401. */
  1402. export function padEnd(str: string, targetLength: number, padString?: string): string;
  1403. export function padEnd(str: any, targetLength: number, padString?: any): string;
  1404. /**
  1405. * 判断字符串是否在源字符串的头部
  1406. * @param str 字符串
  1407. * @param val 值
  1408. * @param startIndex 开始索引
  1409. */
  1410. export function startsWith(str: number | string | null, val: string, startIndex?: number): string;
  1411. /**
  1412. * 判断字符串是否在源字符串的头部
  1413. * @param str 字符串
  1414. * @param val 值
  1415. */
  1416. export function endsWith(str: string, val: string): string;
  1417. /**
  1418. * 判断字符串是否在源字符串的头部
  1419. * @param str 字符串
  1420. * @param val 值
  1421. * @param startIndex 开始索引
  1422. */
  1423. export function endsWith(str: string, val: string, startIndex: number): string;
  1424. /**
  1425. * 解析动态字符串模板
  1426. * @param str 字符串模板
  1427. * @param args 对象
  1428. */
  1429. export function template(str: string, args: any | any[]): string;
  1430. export function template(str: any, args: any | any[]): string;
  1431. export function template(str: string, args: any | any[], options: { tmplRE?: RegExp }): string;
  1432. export function template(str: any, args: any | any[], options: { tmplRE?: RegExp }): string;
  1433. /**
  1434. * 字符串格式化占位符
  1435. * @param { string } str
  1436. * @param { object | any[] } obj
  1437. */
  1438. export function toFormatString(str: string | null, list: any[]): string;
  1439. export function toFormatString(str: any, obj: any): string;
  1440. /**
  1441. * 转字符串
  1442. * @param obj 值
  1443. */
  1444. export function toString(obj: any): string;
  1445. /**
  1446. * 转字符串
  1447. * @param obj 值
  1448. */
  1449. export function toValueString(obj: number | string | any[] | null): string;
  1450. export function toValueString(obj: any): string;
  1451. /**
  1452. * 返回一个获取对象属性的函数
  1453. * @param path 键值
  1454. */
  1455. export function property(path: string | null): Function;
  1456. /**
  1457. * 创建一个绑定上下文的函数
  1458. * @param callback 回调
  1459. * @param context 上下文
  1460. * @param params 额外的参数
  1461. */
  1462. export function bind<C = any>(callback: (this: C, ...args: any[]) => any, context?: C, ...params: any[]): (this: any, ...args: any[]) => any;
  1463. /**
  1464. * 创建一个只能调用一次的函数,只会返回第一次执行后的结果
  1465. * @param callback 回调
  1466. * @param context 上下文
  1467. * @param params 额外的参数
  1468. */
  1469. export function once<S, C = any>(callback: (this: S, ...args: any[]) => any, context?: C, ...params: any[]): (this: S | C, ...args: any[]) => any;
  1470. /**
  1471. * 创建一个函数, 调用次数超过 count 次之后执行回调并将所有结果记住后返回
  1472. * @param count 次数
  1473. * @param callback 回调
  1474. * @param context 上下文
  1475. */
  1476. export function after<C = any>(count: number, callback: (this: C, ...args: any[]) => any, context?: C): (this: any, ...args: any[]) => any;
  1477. /**
  1478. * 创建一个函数, 调用次数不超过 count 次之前执行回调并将所有结果记住后返回
  1479. * @param count 次数
  1480. * @param callback 回调
  1481. * @param context 上下文
  1482. */
  1483. export function before<C = any>(count: number, callback: (this: C, rests: any[], ...args: any[]) => any, context?: C): (this: any, ...args: any[]) => any;
  1484. export interface ThrottleOptions {
  1485. /**
  1486. * 是否在之前执行
  1487. */
  1488. leading?: boolean;
  1489. /**
  1490. * 是否在之后执行
  1491. */
  1492. trailing?: boolean;
  1493. }
  1494. /**
  1495. * 节流函数;当被调用 n 毫秒后才会执行,如果在这时间内又被调用则至少每隔 n 秒毫秒调用一次该函数
  1496. * @param callback 回调
  1497. * @param wait 毫秒
  1498. * @param options 可选参数
  1499. */
  1500. export function throttle<C = any>(callback: (this: C, ...args: any[]) => any, wait: number, options?: ThrottleOptions): (this: C, ...args: any[]) => any;
  1501. export interface DebounceOptions {
  1502. /**
  1503. * 是否在之前执行
  1504. */
  1505. leading?: boolean;
  1506. /**
  1507. * 是否在之后执行
  1508. */
  1509. trailing?: boolean;
  1510. }
  1511. /**
  1512. * 函数去抖;当被调用 n 毫秒后才会执行,如果在这时间内又被调用则将重新计算执行时间
  1513. * @param callback 回调
  1514. * @param wait 毫秒
  1515. * @param options 可选参数
  1516. */
  1517. export function debounce<C = any>(callback: (this: C, ...args: any[]) => any, wait: number, options?: DebounceOptions): (this: C, ...args: any[]) => any;
  1518. /**
  1519. * 该方法和 setTimeout 一样的效果,区别就是支持上下文和额外参数
  1520. * @param callback 回调
  1521. * @param wait 延迟毫秒
  1522. * @param params 额外的参数
  1523. */
  1524. export function delay(callback: (...args: any[]) => any, wait: number, ...params: any[]): number;
  1525. export interface XEUrl {
  1526. /**
  1527. * 获取完整的地址
  1528. */
  1529. href: string;
  1530. /**
  1531. * 获取 #Hash 的完整字符串
  1532. */
  1533. hash: string;
  1534. /**
  1535. * 获取主机信息
  1536. */
  1537. host: string;
  1538. /**
  1539. * 主机主机名
  1540. */
  1541. hostname: string;
  1542. /**
  1543. * 获取地址的协议类型
  1544. */
  1545. protocol: string;
  1546. /**
  1547. * 获取端口信息
  1548. */
  1549. port: string;
  1550. /**
  1551. * 查询字符串
  1552. */
  1553. search: string;
  1554. /**
  1555. * 获取路径字符串
  1556. */
  1557. pathname: string;
  1558. /**
  1559. * 获取 #hash 键值
  1560. */
  1561. origin: string;
  1562. /**
  1563. * 获取 #hash 键值,不包括参数
  1564. */
  1565. hashKey: string;
  1566. /**
  1567. * 获取 #hash 对象参数
  1568. */
  1569. hashQuery: any;
  1570. /**
  1571. * 获取查询对象参数
  1572. */
  1573. searchQuery: any;
  1574. }
  1575. /**
  1576. * 解析 URL 参数
  1577. * @param ulr 字符串
  1578. */
  1579. export function parseUrl(ulr: string): XEUrl;
  1580. export function parseUrl(ulr: any): XEUrl;
  1581. /**
  1582. * 序列化查询参数
  1583. * @param query 查询参数
  1584. */
  1585. export function serialize(query: any): string;
  1586. /**
  1587. * 反序列化查询参数
  1588. * @param str 字符串
  1589. */
  1590. export function unserialize(str: string): any;
  1591. export function unserialize(str: any): any;
  1592. /**
  1593. * 获取上下文路径
  1594. */
  1595. export function getBaseURL(): string;
  1596. /**
  1597. * 获取地址栏信息
  1598. */
  1599. export function locat(): XEUrl;
  1600. export interface XEBrowse {
  1601. /**
  1602. * 判断是否 NodeJs 环境
  1603. */
  1604. isNode: boolean;
  1605. /**
  1606. * 判断是否有 document 元素
  1607. */
  1608. isDoc: boolean;
  1609. /**
  1610. * 判断是否 Edge 浏览器
  1611. */
  1612. edge: boolean;
  1613. /**
  1614. * 判断是否 Firefox 浏览器
  1615. */
  1616. firefox: boolean;
  1617. /**
  1618. * 判断是否 IE 浏览器
  1619. */
  1620. msie: boolean;
  1621. /**
  1622. * 判断是否 Safari 浏览器
  1623. */
  1624. safari: boolean;
  1625. /**
  1626. * 判断是否移动端
  1627. */
  1628. isMobile: boolean;
  1629. /**
  1630. * 判断是否 PC 端
  1631. */
  1632. isPC: boolean;
  1633. /**
  1634. * 判断浏览器是否支持 LocalStorage
  1635. */
  1636. isLocalStorage: boolean;
  1637. /**
  1638. * 判断浏览器是否支持 SessionStorage
  1639. */
  1640. isSessionStorage: boolean;
  1641. /**
  1642. * 判断浏览器是否 -webkit 内核
  1643. */
  1644. '-webkit': boolean;
  1645. /**
  1646. * 判断浏览器是否 -moz 内核
  1647. */
  1648. '-moz': boolean;
  1649. /**
  1650. * 判断浏览器是否 -ms 内核
  1651. */
  1652. '-ms': boolean;
  1653. /**
  1654. * 判断浏览器是否 -o 内核
  1655. */
  1656. '-o': boolean;
  1657. }
  1658. /**
  1659. * 获取浏览器信息
  1660. */
  1661. export function browse(): XEBrowse;
  1662. export interface CookieOptions {
  1663. /**
  1664. * 键
  1665. */
  1666. name?: string;
  1667. /**
  1668. * 值
  1669. */
  1670. value?: string;
  1671. /**
  1672. * 路径
  1673. */
  1674. path?: string;
  1675. /**
  1676. * 作用域
  1677. */
  1678. domain?: string;
  1679. /**
  1680. * 设置为安全的,只能用https协议
  1681. */
  1682. secure?: string;
  1683. /**
  1684. * 过期时间,可以指定日期或者字符串,默认天
  1685. */
  1686. expires?: string;
  1687. }
  1688. /**
  1689. * Cookie 操作函数
  1690. */
  1691. export function CookieFunc(): XECookie;
  1692. /**
  1693. * Cookie 操作函数
  1694. * @param name 键/数组/对象
  1695. */
  1696. export function CookieFunc(name: string): XECookie;
  1697. /**
  1698. * Cookie 操作函数
  1699. * @param name 键/数组/对象
  1700. * @param value 值
  1701. */
  1702. export function CookieFunc(name: string, value: any): XECookie;
  1703. /**
  1704. * Cookie 操作函数
  1705. * @param name 键/数组/对象
  1706. * @param value 值
  1707. * @param options 可选参数
  1708. */
  1709. export function CookieFunc(name: string, value: any, options: CookieOptions): XECookie;
  1710. export type XECookie = typeof CookieFunc & {
  1711. /**
  1712. * 根据 name 判断 Cookie 是否存在
  1713. * @param name 键
  1714. */
  1715. has(name: string): boolean;
  1716. /**
  1717. * 添加 Cookie
  1718. * @param name 键
  1719. * @param value 值
  1720. * @param options 可选参数
  1721. */
  1722. set(name: string, value: any, options?: CookieOptions): XECookie;
  1723. /**
  1724. * 根据 name 获取 Cookie
  1725. * @param name 键
  1726. */
  1727. get(name: string): string;
  1728. /**
  1729. * 根据 name 删除 Cookie
  1730. * @param name 键
  1731. * @param options 可选参数
  1732. */
  1733. remove(name: string, options?: CookieOptions): number;
  1734. /**
  1735. * 获取 Cookie 所有键
  1736. */
  1737. keys(): any[];
  1738. /**
  1739. * 获取所有 Cookie
  1740. */
  1741. getJSON(): any;
  1742. }
  1743. export const cookie: XECookie
  1744. }