diff options
Diffstat (limited to 'date-fns/src/millisecondsToSeconds/index.ts')
-rw-r--r-- | date-fns/src/millisecondsToSeconds/index.ts | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/date-fns/src/millisecondsToSeconds/index.ts b/date-fns/src/millisecondsToSeconds/index.ts new file mode 100644 index 0000000..ea35328 --- /dev/null +++ b/date-fns/src/millisecondsToSeconds/index.ts @@ -0,0 +1,31 @@ +import requiredArgs from '../_lib/requiredArgs/index' +import { millisecondsInSecond } from '../constants/index' + +/** + * @name millisecondsToSeconds + * @category Conversion Helpers + * @summary Convert milliseconds to seconds. + * + * @description + * Convert a number of milliseconds to a full number of seconds. + * + * @param {number} milliseconds - number of milliseconds to be converted + * + * @returns {number} the number of milliseconds converted in seconds + * @throws {TypeError} 1 argument required + * + * @example + * // Convert 1000 miliseconds to seconds: + * const result = millisecondsToSeconds(1000) + * //=> 1 + * + * @example + * // It uses floor rounding: + * const result = millisecondsToSeconds(1999) + * //=> 1 + */ +export default function millisecondsToSeconds(milliseconds: number): number { + requiredArgs(1, arguments) + const seconds = milliseconds / millisecondsInSecond + return Math.floor(seconds) +} |