xe-utils.d.ts 54 KB

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