summaryrefslogtreecommitdiff
path: root/date-fns/src/secondsToHours
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/secondsToHours')
-rw-r--r--date-fns/src/secondsToHours/index.d.ts4
-rw-r--r--date-fns/src/secondsToHours/index.js.flow52
-rw-r--r--date-fns/src/secondsToHours/index.ts31
-rw-r--r--date-fns/src/secondsToHours/test.ts21
4 files changed, 108 insertions, 0 deletions
diff --git a/date-fns/src/secondsToHours/index.d.ts b/date-fns/src/secondsToHours/index.d.ts
new file mode 100644
index 0000000..89fcc9a
--- /dev/null
+++ b/date-fns/src/secondsToHours/index.d.ts
@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import { secondsToHours } from 'date-fns'
+export default secondsToHours
diff --git a/date-fns/src/secondsToHours/index.js.flow b/date-fns/src/secondsToHours/index.js.flow
new file mode 100644
index 0000000..371c79a
--- /dev/null
+++ b/date-fns/src/secondsToHours/index.js.flow
@@ -0,0 +1,52 @@
+// @flow
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+export type Interval = {
+ start: Date | number,
+ end: Date | number,
+}
+
+export type Locale = {
+ code?: string,
+ formatDistance?: (...args: Array<any>) => any,
+ formatRelative?: (...args: Array<any>) => any,
+ localize?: {
+ ordinalNumber: (...args: Array<any>) => any,
+ era: (...args: Array<any>) => any,
+ quarter: (...args: Array<any>) => any,
+ month: (...args: Array<any>) => any,
+ day: (...args: Array<any>) => any,
+ dayPeriod: (...args: Array<any>) => any,
+ },
+ formatLong?: {
+ date: (...args: Array<any>) => any,
+ time: (...args: Array<any>) => any,
+ dateTime: (...args: Array<any>) => any,
+ },
+ match?: {
+ ordinalNumber: (...args: Array<any>) => any,
+ era: (...args: Array<any>) => any,
+ quarter: (...args: Array<any>) => any,
+ month: (...args: Array<any>) => any,
+ day: (...args: Array<any>) => any,
+ dayPeriod: (...args: Array<any>) => any,
+ },
+ options?: {
+ weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+ firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
+ },
+}
+
+export type Duration = {
+ years?: number,
+ months?: number,
+ weeks?: number,
+ days?: number,
+ hours?: number,
+ minutes?: number,
+ seconds?: number,
+}
+
+export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6
+
+declare module.exports: (seconds: number) => number
diff --git a/date-fns/src/secondsToHours/index.ts b/date-fns/src/secondsToHours/index.ts
new file mode 100644
index 0000000..ba87b10
--- /dev/null
+++ b/date-fns/src/secondsToHours/index.ts
@@ -0,0 +1,31 @@
+import requiredArgs from '../_lib/requiredArgs/index'
+import { secondsInHour } from '../constants/index'
+
+/**
+ * @name secondsToHours
+ * @category Conversion Helpers
+ * @summary Convert seconds to hours.
+ *
+ * @description
+ * Convert a number of seconds to a full number of hours.
+ *
+ * @param {number} seconds - number of seconds to be converted
+ *
+ * @returns {number} the number of seconds converted in hours
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // Convert 7200 seconds into hours
+ * const result = secondsToHours(7200)
+ * //=> 2
+ *
+ * @example
+ * // It uses floor rounding:
+ * const result = secondsToHours(7199)
+ * //=> 1
+ */
+export default function secondsToHours(seconds: number): number {
+ requiredArgs(1, arguments)
+ const hours = seconds / secondsInHour
+ return Math.floor(hours)
+}
diff --git a/date-fns/src/secondsToHours/test.ts b/date-fns/src/secondsToHours/test.ts
new file mode 100644
index 0000000..12b3ecf
--- /dev/null
+++ b/date-fns/src/secondsToHours/test.ts
@@ -0,0 +1,21 @@
+/* eslint-env mocha */
+
+import assert from 'assert'
+import secondsToHours from '.'
+
+describe('secondsToHours', function () {
+ it('converts seconds to hours', function () {
+ assert(secondsToHours(3600) === 1)
+ assert(secondsToHours(7200) === 2)
+ })
+
+ it('uses floor rounding', () => {
+ assert(secondsToHours(3601) === 1)
+ assert(secondsToHours(3599) === 0)
+ })
+
+ it('handles border values', () => {
+ assert(secondsToHours(3600.5) === 1)
+ assert(secondsToHours(0) === 0)
+ })
+})