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