date.d.ts 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. /**
  2. * 日期和时间相关
  3. *
  4. * 更复杂的日期操作建议直接使用 dayjs https://dayjs.gitee.io/docs/zh-CN/installation/installation
  5. */
  6. import dayjs from 'dayjs';
  7. export { dayjs };
  8. /**
  9. * @group 日期格式
  10. * @groupOrder 4
  11. */
  12. export declare const DATE_FORMAT = "YYYY-MM-DD";
  13. /**
  14. * @group 日期格式
  15. * @groupOrder 4
  16. */
  17. export declare const DATE_TIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
  18. export declare const SECOND = 1000;
  19. export declare const MINUTE: number;
  20. export declare const HOUR: number;
  21. export declare const DAY: number;
  22. /**
  23. * 日期解析
  24. *
  25. * @group 日期
  26. * @groupOrder 5
  27. *
  28. * @remarks
  29. * 如果传入数字,我们假定为`毫秒` <br/>
  30. *` parseDate`会先尝试常见的日期格式(例如 YYYY/MM/DD HH:mm:ss、YYYY-MM-DD HH:mm:ss、YYYY-MM-DD),如果`parse`失败就会使用`format`
  31. *
  32. * @param dateString - 要转换成日期的数字和字符串.
  33. * @param format - 用于指定日期的格式。如果你的日期格式不是常见的格式,可以显式指定
  34. * @link https://dayjs.gitee.io/docs/zh-CN/parse/string-format
  35. *
  36. * @example
  37. * 例子:
  38. * ```typescript
  39. * parseDate(3600)
  40. * // => 1970-01-01T00:00:03.600Z
  41. *
  42. * parseDate('2012/12/10 12:12:12')
  43. * // => 2012-02-10T04:12:12.000Z
  44. * ```
  45. * @public
  46. */
  47. export declare function parseDate(dateString: string | number | Date, format?: string | string[]): Date | null;
  48. /**
  49. * 格式化日期
  50. *
  51. * @group 日期
  52. * @groupOrder 5
  53. *
  54. * @remarks
  55. * 如果传入数字,我们假定为`毫秒`
  56. *
  57. * @param date - 日期.
  58. * @param format - 详见 {@link https://dayjs.gitee.io/docs/zh-CN/parse/string-format}.
  59. *
  60. * @example
  61. * 例子:
  62. * ```
  63. * const day = new Date('2012/12/12 12:12:12');
  64. *
  65. * const target = formatDate(day);
  66. * // => target = "2012-02-10"
  67. *
  68. * const target2 = formatDate(day, 'YYYY-MM-DD HH:mm:ss');
  69. * // => target2 = "2012-02-10 12:12:12"
  70. * ```
  71. * @public
  72. */
  73. export declare function formatDate(date: string | number | Date, format?: string, parseFormat?: string | string[]): string;
  74. //# sourceMappingURL=date.d.ts.map