1.1.0

Author: runely

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtfk/utilities",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A collection of uncategorized javascript functionality used in multiple projects",
   "main": "index.js",
   "scripts": {

package.json

@@ -0,0 +1,59 @@
+const { formatRelativeDate } = require('../../util/relative-date-format')
+
+/* formatRelativeDate(new Date(), new Date(), 'en', {
+
+}) */
+
+describe('formatRelativeDate', () => {
+  test('no arguments passed - should throw error', () => {
+    expect(() => formatRelativeDate()).toThrow()
+  })
+
+  describe('toDate passed as seven days ahead', () => {
+    test('and locale default as "en" - should return "in 7 days"', () => {
+      const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+      const formatted = formatRelativeDate(futureDate)
+      expect(formatted).toBe('in 7 days' || 'in 1 week')
+    })
+
+    test('and locale passed as "no" - should return "om 1 uke"', () => {
+      const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+      const formatted = formatRelativeDate(futureDate, new Date(), 'no')
+      expect(formatted).toBe('om 1 uke' || 'om 7 døgn')
+    })
+
+    describe('numeric passed as', () => {
+      test('"auto" - should return "next week" or "in 7 days"', () => {
+        const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+        const formatted = formatRelativeDate(futureDate, new Date(), 'en', { numeric: 'auto' })
+        expect(formatted).toBe('next week' || 'in 7 days')
+      })
+
+      test('"always" - should return "in 1 week"', () => {
+        const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+        const formatted = formatRelativeDate(futureDate, new Date(), 'en', { numeric: 'always' })
+        expect(formatted).toBe('in 1 week')
+      })
+    })
+
+    describe('style passed as', () => {
+      test('"long" - should return "in 1 week"', () => {
+        const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+        const formatted = formatRelativeDate(futureDate, new Date(), 'en', { style: 'long' })
+        expect(formatted).toBe('in 1 week')
+      })
+
+      test('"short" - should return "in 1 wk."', () => {
+        const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+        const formatted = formatRelativeDate(futureDate, new Date(), 'en', { style: 'short' })
+        expect(formatted).toBe('in 1 wk.')
+      })
+
+      test('"narrow" - should return "in 1 wk." or "in 7 days"', () => {
+        const futureDate = new Date(new Date().setDate(new Date().getDate() + 7))
+        const formatted = formatRelativeDate(futureDate, new Date(), 'en', { style: 'narrow' })
+        expect(formatted).toBe('in 1 wk.' || 'in 7 days')
+      })
+    })
+  })
+})

tests/util/relative-date-format.test.js

@@ -0,0 +1,14 @@
+export function formatRelativeDate(toDate: Date, fromDate?: Date, locale?: string, options?: any): string;
+/**
+ * RelativeTimeFormat options
+ */
+export type RelativeTimeFormatOptions = {
+    /**
+     * "Always" use numeric values or "auto" choose value
+     */
+    numeric?: "always" | "auto";
+    /**
+     * "long" time style, "short" time style or "narrow" time style
+     */
+    style?: "long" | "short" | "narrow";
+};

util/relative-date-format.d.ts

@@ -0,0 +1,49 @@
+const DIVISIONS = [
+  { amount: 60, name: 'seconds' },
+  { amount: 60, name: 'minutes' },
+  { amount: 24, name: 'hours' },
+  { amount: 7, name: 'days' },
+  { amount: 4.34524, name: 'weeks' },
+  { amount: 12, name: 'months' },
+  { amount: Number.POSITIVE_INFINITY, name: 'years' }
+]
+
+/**
+ * RelativeTimeFormat options
+ * @typedef {Object} RelativeTimeFormatOptions
+ * @property {"always"|"auto"} [numeric] "Always" use numeric values or "auto" choose value
+ * @property {"long"|"short"|"narrow"} [style] "long" time style, "short" time style or "narrow" time style
+ */
+
+/**
+ * Format number into relative time
+ * @param {String} locale Locale to format into - (Default = en)
+ * @param {RelativeTimeFormatOptions} options RelativeTimeFormat options
+ * @returns Formatted string
+ */
+const getRelativeTimeFormatter = (locale, options) => {
+  return new Intl.RelativeTimeFormat(locale, options)
+}
+
+/**
+ * Formats the duratio between two dates into a relative time
+ * @param {Date} toDate Date object to format relative date from
+ * @param {Date} fromDate (optional) Date object to be starting point (Default = new Date())
+ * @param {String} locale Locale to format date into
+ * @param {Object} options RelativeTimeFormat options
+ * @returns The formatted string
+ */
+module.exports.formatRelativeDate = (toDate, fromDate = new Date(), locale = 'en', options = undefined) => {
+  if (toDate === null || toDate === undefined) throw new Error('Pass at least "toDate"')
+
+  const FORMATTER = getRelativeTimeFormatter(locale, options)
+  let duration = (toDate - fromDate) / 1000
+
+  for (let i = 0; i < DIVISIONS.length; i++) {
+    const division = DIVISIONS[i]
+    if (Math.abs(duration) < division.amount) {
+      return FORMATTER.format(Math.round(duration), division.name)
+    }
+    duration /= division.amount
+  }
+}