xe-utils.d.ts 54 KB

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