Merge pull request #236 from sasjs/convertSecondsToHms

feat: add a utility for converting seconds to Hour, minutes and seconds

src/time/index.ts

@@ -1 +1,5 @@
-export { timestampToYYYYMMDDHHMMSS, generateTimestamp } from './timestamp'
+export {
+  convertSecondsToHms,
+  timestampToYYYYMMDDHHMMSS,
+  generateTimestamp
+} from './timestamp'

src/time/timestamp.spec.ts

@@ -1,4 +1,8 @@
-import { timestampToYYYYMMDDHHMMSS, generateTimestamp } from './timestamp'
+import {
+  convertSecondsToHms,
+  timestampToYYYYMMDDHHMMSS,
+  generateTimestamp
+} from './timestamp'
 
 describe('timestampToYYYYMMDDHHMMSS', () => {
   const regExp = /^\d{4}\/\d{1,2}\/\d{1,2} \d{1,2}:\d{1,2}:\d{1,2}/
@@ -74,3 +78,33 @@ describe('generateTimestamp', () => {
     global.Date = realDate
   })
 })
+
+describe('convertSecondsToHms', () => {
+  const hour = 3600 // 3600 secs = 1 hour
+  const minute = 60 // 60 secs = 1 min
+
+  test('should convert seconds to Hms', () => {
+    expect(convertSecondsToHms(1 * hour)).toEqual('1 hour')
+    expect(convertSecondsToHms(2 * hour)).toEqual('2 hours')
+    expect(convertSecondsToHms(1 * hour + 1 * minute)).toEqual(
+      '1 hour, 1 minute'
+    )
+    expect(convertSecondsToHms(1 * hour + 2 * minute)).toEqual(
+      '1 hour, 2 minutes'
+    )
+    expect(convertSecondsToHms(2 * hour + 1 * minute)).toEqual(
+      '2 hours, 1 minute'
+    )
+    expect(convertSecondsToHms(2 * hour + 2 * minute)).toEqual(
+      '2 hours, 2 minutes'
+    )
+    expect(convertSecondsToHms(2 * hour + 2 * minute + 30)).toEqual(
+      '2 hours, 2 minutes, 30 seconds'
+    )
+    expect(convertSecondsToHms(2 * hour + 30)).toEqual('2 hours, 30 seconds')
+    expect(convertSecondsToHms(2 * minute + 30)).toEqual(
+      '2 minutes, 30 seconds'
+    )
+    expect(convertSecondsToHms(0)).toEqual('0 second')
+  })
+})

src/time/timestamp.ts

@@ -18,7 +18,7 @@ export const timestampToYYYYMMDDHHMMSS = (timestamp: number = Date.now()) => {
   )
 }
 
-export function generateTimestamp(sep = '', sepIndex?: number): string {
+export const generateTimestamp = (sep = '', sepIndex?: number): string => {
   const date = new Date()
 
   let timestamp: string | (number | string)[] = [
@@ -40,3 +40,29 @@ export function generateTimestamp(sep = '', sepIndex?: number): string {
 
   return timestamp
 }
+
+export const convertSecondsToHms = (totalSeconds: number) => {
+  if (!totalSeconds) return '0 second'
+
+  const totalMinutes = Math.floor(totalSeconds / 60)
+
+  const hours = Math.floor(totalMinutes / 60)
+  const minutes = totalMinutes % 60
+  const seconds = totalSeconds % 60
+
+  let result = ''
+
+  if (hours > 0) {
+    result = hours + ` hour${hours > 1 ? 's' : ''}`
+  }
+
+  if (minutes > 0) {
+    result += `${result ? ', ' : ''}${minutes} minute${minutes > 1 ? 's' : ''}`
+  }
+
+  if (seconds > 0) {
+    result += `${result ? ', ' : ''}${seconds} second${seconds > 1 ? 's' : ''}`
+  }
+
+  return result
+}