index.js 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = millisecondsToSeconds;
  7. var _index = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  8. var _index2 = require("../constants/index.js");
  9. /**
  10. * @name millisecondsToSeconds
  11. * @category Conversion Helpers
  12. * @summary Convert milliseconds to seconds.
  13. *
  14. * @description
  15. * Convert a number of milliseconds to a full number of seconds.
  16. *
  17. * @param {number} milliseconds - number of milliseconds to be converted
  18. *
  19. * @returns {number} the number of milliseconds converted in seconds
  20. * @throws {TypeError} 1 argument required
  21. *
  22. * @example
  23. * // Convert 1000 miliseconds to seconds:
  24. * const result = millisecondsToSeconds(1000)
  25. * //=> 1
  26. *
  27. * @example
  28. * // It uses floor rounding:
  29. * const result = millisecondsToSeconds(1999)
  30. * //=> 1
  31. */
  32. function millisecondsToSeconds(milliseconds) {
  33. (0, _index.default)(1, arguments);
  34. var seconds = milliseconds / _index2.millisecondsInSecond;
  35. return Math.floor(seconds);
  36. }
  37. module.exports = exports.default;