xe-utils.d.ts 57 KB

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