fix: set relativeTimeThreshold for amTimeAgo

Fixes urish#231
libinvarghese · Mar 1, 2021 · f3bdfb4 · f3bdfb4
1 parent e8becd4
commit f3bdfb4
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 21 deletions.
diff --git a/src/duration.pipe.ts b/src/duration.pipe.ts
@@ -1,12 +1,10 @@
 import * as moment from 'moment';
 
 import { Inject, Optional, Pipe, PipeTransform } from '@angular/core';
-import { NGX_MOMENT_OPTIONS, NgxMomentOptions } from './moment-options';
+import { NGX_MOMENT_OPTIONS, NgxMomentOptions, applyOptions } from './moment-options';
 
 @Pipe({ name: 'amDuration' })
 export class DurationPipe implements PipeTransform {
-  allowedUnits: Array<string> = ['ss', 's', 'm', 'h', 'd', 'M'];
-
   constructor(@Optional() @Inject(NGX_MOMENT_OPTIONS) momentOptions?: NgxMomentOptions) {
     this._applyOptions(momentOptions);
   }
@@ -19,18 +17,6 @@ export class DurationPipe implements PipeTransform {
   }
 
   private _applyOptions(momentOptions: NgxMomentOptions): void {
-    if (!momentOptions) {
-      return;
-    }
-
-    if (!!momentOptions.relativeTimeThresholdOptions) {
-      const units: Array<string> = Object.keys(momentOptions.relativeTimeThresholdOptions);
-      const filteredUnits: Array<string> = units.filter(
-        (unit) => this.allowedUnits.indexOf(unit) !== -1,
-      );
-      filteredUnits.forEach((unit) => {
-        moment.relativeTimeThreshold(unit, momentOptions.relativeTimeThresholdOptions[unit]);
-      });
-    }
+    applyOptions(momentOptions);
   }
 }
diff --git a/src/moment-options.ts b/src/moment-options.ts
@@ -1,8 +1,9 @@
 import { InjectionToken } from '@angular/core';
+import * as moment from 'moment';
 
-export const NGX_MOMENT_OPTIONS: InjectionToken<NgxMomentOptions> = new InjectionToken<
-  NgxMomentOptions
->('NGX_MOMENT_OPTIONS');
+export const NGX_MOMENT_OPTIONS: InjectionToken<NgxMomentOptions> = new InjectionToken<NgxMomentOptions>(
+  'NGX_MOMENT_OPTIONS',
+);
 
 export interface NgxMomentOptions {
   /**
@@ -16,3 +17,19 @@ export interface NgxMomentOptions {
    */
   relativeTimeThresholdOptions: { [key: string]: number };
 }
+
+export function applyOptions(momentOptions: NgxMomentOptions): void {
+  const allowedUnits: Array<string> = ['ss', 's', 'm', 'h', 'd', 'M'];
+
+  if (!momentOptions) {
+    return;
+  }
+
+  if (!!momentOptions.relativeTimeThresholdOptions) {
+    const units: Array<string> = Object.keys(momentOptions.relativeTimeThresholdOptions);
+    const filteredUnits: Array<string> = units.filter((unit) => allowedUnits.indexOf(unit) !== -1);
+    filteredUnits.forEach((unit) => {
+      moment.relativeTimeThreshold(unit, momentOptions.relativeTimeThresholdOptions[unit]);
+    });
+  }
+}
diff --git a/src/time-ago.pipe.spec.ts b/src/time-ago.pipe.spec.ts
@@ -2,6 +2,7 @@ import { NgZone } from '@angular/core';
 import { TimeAgoPipe } from './time-ago.pipe';
 import * as moment from 'moment';
 import 'moment/min/locales';
+import { NgxMomentOptions } from './moment-options';
 
 declare var global: any;
 
@@ -130,5 +131,23 @@ describe('TimeAgoPipe', () => {
       expect(pipe.transform(moment().add(1, 'h'), false, formatFnMock)).toBe('');
       expect(pipe.transform(moment().add(3, 'h'), false, formatFnMock)).toBe('');
     });
+
+    it(`should transform '50 minutes before' to 'an hour ago' with default 'relativeTimeThreshold'`, () => {
+      const pipe = new TimeAgoPipe(null, new NgZoneMock() as NgZone);
+      expect(pipe.transform(moment().subtract(50, 'minutes'))).toEqual('an hour ago');
+    });
+  });
+
+  describe('ctor with NgxMomentOptions', () => {
+    const momentOptions: NgxMomentOptions = {
+      relativeTimeThresholdOptions: {
+        m: 59,
+      },
+    };
+
+    it(`should transform '50 minutes before' to '50 minutes ago' when relativeTimeThreshold for 'm' unit is set to 59`, () => {
+      const pipe = new TimeAgoPipe(null, new NgZoneMock() as NgZone, momentOptions);
+      expect(pipe.transform(moment().subtract(50, 'minutes'))).toEqual('50 minutes ago');
+    });
   });
 });
diff --git a/src/time-ago.pipe.ts b/src/time-ago.pipe.ts
@@ -1,7 +1,16 @@
 /* ngx-moment (c) 2015, 2016 Uri Shaked / MIT Licence */
 
-import { Pipe, ChangeDetectorRef, PipeTransform, OnDestroy, NgZone } from '@angular/core';
+import {
+  Pipe,
+  ChangeDetectorRef,
+  PipeTransform,
+  OnDestroy,
+  NgZone,
+  Optional,
+  Inject,
+} from '@angular/core';
 import * as moment from 'moment';
+import { applyOptions, NgxMomentOptions, NGX_MOMENT_OPTIONS } from './moment-options';
 
 const momentConstructor = moment;
 
@@ -16,7 +25,13 @@ export class TimeAgoPipe implements PipeTransform, OnDestroy {
   private lastText: string;
   private formatFn: (m: moment.Moment) => string;
 
-  constructor(private cdRef: ChangeDetectorRef, private ngZone: NgZone) {}
+  constructor(
+    private cdRef: ChangeDetectorRef,
+    private ngZone: NgZone,
+    @Optional() @Inject(NGX_MOMENT_OPTIONS) momentOptions?: NgxMomentOptions,
+  ) {
+    this._applyOptions(momentOptions);
+  }
 
   format(m: moment.Moment) {
     return m.from(momentConstructor(), this.lastOmitSuffix);
@@ -110,4 +125,8 @@ export class TimeAgoPipe implements PipeTransform, OnDestroy {
   private getLocale(value: moment.MomentInput): string | null {
     return moment.isMoment(value) ? value.locale() : moment.locale();
   }
+
+  private _applyOptions(momentOptions: NgxMomentOptions): void {
+    applyOptions(momentOptions);
+  }
 }