index.d.ts 547 B

123456789101112131415161718192021222324252627282930
  1. export type TimeComponents<T extends (number | bigint) = number> = {
  2. days: T;
  3. hours: T;
  4. minutes: T;
  5. seconds: T;
  6. milliseconds: T;
  7. microseconds: T;
  8. nanoseconds: T;
  9. };
  10. /**
  11. Parse milliseconds into an object.
  12. @example
  13. ```
  14. import parseMilliseconds from 'parse-ms';
  15. parseMilliseconds(1337000001);
  16. // {
  17. // days: 15,
  18. // hours: 11,
  19. // minutes: 23,
  20. // seconds: 20,
  21. // milliseconds: 1,
  22. // microseconds: 0,
  23. // nanoseconds: 0
  24. // }
  25. ```
  26. */
  27. export default function parseMilliseconds<T extends number | bigint>(milliseconds: T): TimeComponents<T>;