getDateDiff.d.ts 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. export interface DateDiffResult {
  2. /**
  3. * 是否计算完成(如果结束日期小于开始日期 done 为 fasle)
  4. */
  5. done: boolean;
  6. /**
  7. * 相差多少毫秒
  8. */
  9. time: Number;
  10. /**
  11. * 年
  12. */
  13. yyyy: number;
  14. /**
  15. * 月
  16. */
  17. MM: number;
  18. /**
  19. * 日
  20. */
  21. dd: number;
  22. /**
  23. * 时
  24. */
  25. HH: number;
  26. /**
  27. * 分
  28. */
  29. mm: number;
  30. /**
  31. * 秒
  32. */
  33. ss: number;
  34. /**
  35. * 毫秒
  36. */
  37. S: number;
  38. }
  39. /**
  40. * 例如:[['yyyy', 31536000000], ['MM', 2592000000], ['dd', 86400000], ['HH', 3600000], ['mm', 60000], ['ss', 1000], ['S', 0]]
  41. */
  42. export type GetDateDiffRules = any[][]
  43. /**
  44. * 返回两个日期之间差距,如果结束日期小于开始日期 done 为 fasle
  45. * @param startDate 开始日期
  46. * @param endDate 结束日期或当期日期
  47. */
  48. export declare function getDateDiff(startDate: string | Date | number, endDate: string | Date | number): DateDiffResult;
  49. /**
  50. * 返回两个日期之间差距,如果结束日期小于开始日期 done 为 fasle
  51. * @param startDate 开始日期
  52. * @param endDate 结束日期或当期日期
  53. * @param rules 自定义计算规则
  54. */
  55. export declare function getDateDiff(startDate: string | Date | number, endDate: string | Date | number, rules?: GetDateDiffRules): DateDiffResult;
  56. declare module './ctor' {
  57. interface XEUtilsMethods {
  58. getDateDiff: typeof getDateDiff;
  59. }
  60. }
  61. export default getDateDiff