ng-time-past-pipe
Version:
Reactive textual representation of the time that has been passed between a given date and now in your Angular App.
99 lines • 13.1 kB
JavaScript
import { Inject, Pipe, } from '@angular/core';
import { createTimeDiff, TIME_DIFF_GENERATOR, } from './time-diff';
import { UPDATE_INTERVAL_GENERATOR, } from './time-interval';
import { parseInputValue, validateTAInputType } from './time-past';
import { TIME_PAST_TICKER } from './ticker';
import { filter, map } from 'rxjs/operators';
import * as i0 from "@angular/core";
import * as i1 from "rxjs";
export class TimePastPipe {
/**
* TimePastPipe Class Constructor
*/
constructor(changeDetectorRef, ticker, timeDiffGenerator, updateIntervalGenerator) {
this.changeDetectorRef = changeDetectorRef;
this.ticker = ticker;
this.timeDiffGenerator = timeDiffGenerator;
this.updateIntervalGenerator = updateIntervalGenerator;
this.currentPeriod = 1;
this.intervalTimer = this.ticker.pipe(filter((tick) => tick % this.currentPeriod === 0), map((tick) => tick / this.currentPeriod));
this.intervalSubscription = this.intervalTimer.subscribe(() => {
this.changeDetectorRef.markForCheck();
});
}
/**
* Transform anything that can be parsed to a Date in the past, to a string that represent the relative
* time that has been passed between now and this point of time.
*
* @param value A value that can be parsed to a Date in the past or future
* @param overflow Overflow to time in past when initial date was in future
* @return The textual representation of the time that has been passed between the given Date
* and the current.
*/
transform(value, overflow = true) {
if (this.isValidInput(value) === false) {
return value;
}
const seconds = parseInputValue(value);
this.initialSeconds || (this.initialSeconds = seconds);
if (this.lastSeconds === seconds || (overflow === false && this.initialSeconds < 0 && seconds > 0)) {
return this.lastResult;
}
// The ChangeDetector should not call transform again while the new value is being resolved
this.changeDetectorRef.detach();
this.lastSeconds = seconds;
const timeDiff = createTimeDiff(seconds);
const result = (this.lastResult = this.timeDiffGenerator(timeDiff));
// Make sure the update interval refreshed as well
this.currentPeriod = this.updateIntervalGenerator(timeDiff);
// Reattach the ChangeDetector so that further changes are being transformed
this.changeDetectorRef.reattach();
return result;
}
/**
* Validate the Input Value and log a warning per value when it fails
*
* @param value
* @private
*/
isValidInput(value) {
const validationResult = validateTAInputType(value);
if (validationResult === false && this.lastInput !== value) {
console.warn(`[TimePastPipe] Invalid Input of type ${typeof value} (${value}).`);
}
this.lastInput = value;
return validationResult;
}
/**
* Clear interval ticker subscription
*/
ngOnDestroy() {
if (this.intervalSubscription) {
this.intervalSubscription.unsubscribe();
}
}
}
TimePastPipe.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "14.0.3", ngImport: i0, type: TimePastPipe, deps: [{ token: i0.ChangeDetectorRef }, { token: TIME_PAST_TICKER }, { token: TIME_DIFF_GENERATOR }, { token: UPDATE_INTERVAL_GENERATOR }], target: i0.ɵɵFactoryTarget.Pipe });
TimePastPipe.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "14.0.3", ngImport: i0, type: TimePastPipe, isStandalone: true, name: "timePast", pure: false });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.0.3", ngImport: i0, type: TimePastPipe, decorators: [{
type: Pipe,
args: [{
standalone: true,
name: 'timePast',
pure: false,
}]
}], ctorParameters: function () { return [{ type: i0.ChangeDetectorRef }, { type: i1.Observable, decorators: [{
type: Inject,
args: [TIME_PAST_TICKER]
}] }, { type: undefined, decorators: [{
type: Inject,
args: [TIME_DIFF_GENERATOR]
}] }, { type: undefined, decorators: [{
type: Inject,
args: [UPDATE_INTERVAL_GENERATOR]
}] }]; } });
/**
* @deprecated Use TimePastPipe instead
*/
export const NgTimePastPipePipe = TimePastPipe;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"time-past.pipe.js","sourceRoot":"","sources":["../../../../projects/ng-time-past-pipe/src/lib/time-past.pipe.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,MAAM,EAEN,IAAI,GAEL,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,cAAc,EACd,mBAAmB,GAEpB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,yBAAyB,GAE1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,eAAe,EAAW,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;;;AAO7C,MAAM,OAAO,YAAY;IAavB;;OAEG;IACH,YACmB,iBAAoC,EACV,MAA0B,EAEpD,iBAAoC,EAEpC,uBAAgD;QALhD,sBAAiB,GAAjB,iBAAiB,CAAmB;QACV,WAAM,GAAN,MAAM,CAAoB;QAEpD,sBAAiB,GAAjB,iBAAiB,CAAmB;QAEpC,4BAAuB,GAAvB,uBAAuB,CAAyB;QAhB3D,kBAAa,GAAG,CAAC,CAAC;QACT,kBAAa,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAC/C,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,KAAK,CAAC,CAAC,EACjD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CACzC,CAAC;QAcA,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,EAAE;YAC5D,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,SAAS,CAAoB,KAAQ,EAAE,QAAQ,GAAG,IAAI;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE;YACtC,OAAO,KAAK,CAAC;SACd;QAED,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,KAAnB,IAAI,CAAC,cAAc,GAAK,OAAO,EAAC;QAEhC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,EAAE;YAClG,OAAO,IAAI,CAAC,UAAU,CAAC;SACxB;QAED,2FAA2F;QAC3F,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAEhC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QAE3B,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEpE,kDAAkD;QAClD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAE5D,4EAA4E;QAC5E,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAElC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACK,YAAY,CAAC,KAAc;QACjC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAEpD,IAAI,gBAAgB,KAAK,KAAK,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE;YAC1D,OAAO,CAAC,IAAI,CACV,wCAAwC,OAAO,KAAK,KAAK,KAAK,IAAI,CACnE,CAAC;SACH;QAED,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QAEvB,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,CAAC;SACzC;IACH,CAAC;;yGA9FU,YAAY,mDAkBb,gBAAgB,aAChB,mBAAmB,aAEnB,yBAAyB;uGArBxB,YAAY;2FAAZ,YAAY;kBALxB,IAAI;mBAAC;oBACJ,UAAU,EAAE,IAAI;oBAChB,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,KAAK;iBACZ;;0BAmBI,MAAM;2BAAC,gBAAgB;;0BACvB,MAAM;2BAAC,mBAAmB;;0BAE1B,MAAM;2BAAC,yBAAyB;;AA4ErC;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,YAAY,CAAC","sourcesContent":["import {\n  ChangeDetectorRef,\n  Inject,\n  OnDestroy,\n  Pipe,\n  PipeTransform,\n} from '@angular/core';\nimport {\n  createTimeDiff,\n  TIME_DIFF_GENERATOR,\n  TimeDiffGenerator,\n} from './time-diff';\nimport {\n  UPDATE_INTERVAL_GENERATOR,\n  UpdateIntervalGenerator,\n} from './time-interval';\nimport { parseInputValue, TAInput, validateTAInputType } from './time-past';\nimport { TIME_PAST_TICKER } from './ticker';\nimport { Observable, Subscription } from 'rxjs';\nimport { filter, map } from 'rxjs/operators';\n\n@Pipe({\n  standalone: true,\n  name: 'timePast',\n  pure: false,\n})\nexport class TimePastPipe implements PipeTransform, OnDestroy {\n  private initialSeconds: any;\n  private lastInput: any;\n  private lastSeconds: number;\n  private lastResult: string;\n\n  private currentPeriod = 1;\n  private readonly intervalTimer = this.ticker.pipe(\n    filter((tick) => tick % this.currentPeriod === 0),\n    map((tick) => tick / this.currentPeriod)\n  );\n  private readonly intervalSubscription: Subscription;\n\n  /**\n   * TimePastPipe Class Constructor\n   */\n  constructor(\n    private readonly changeDetectorRef: ChangeDetectorRef,\n    @Inject(TIME_PAST_TICKER) private readonly ticker: Observable<number>,\n    @Inject(TIME_DIFF_GENERATOR)\n    private readonly timeDiffGenerator: TimeDiffGenerator,\n    @Inject(UPDATE_INTERVAL_GENERATOR)\n    private readonly updateIntervalGenerator: UpdateIntervalGenerator\n  ) {\n    this.intervalSubscription = this.intervalTimer.subscribe(() => {\n      this.changeDetectorRef.markForCheck();\n    });\n  }\n\n  /**\n   * Transform anything that can be parsed to a Date in the past, to a string that represent the relative\n   *  time that has been passed between now and this point of time.\n   *\n   * @param value A value that can be parsed to a Date in the past or future\n   * @param overflow Overflow to time in past when initial date was in future\n   * @return The textual representation of the time that has been passed between the given Date\n   *  and the current.\n   */\n  transform<T extends TAInput>(value: T, overflow = true): string | T {\n    if (this.isValidInput(value) === false) {\n      return value;\n    }\n\n    const seconds = parseInputValue(value);\n    this.initialSeconds ||= seconds;\n\n    if (this.lastSeconds === seconds || (overflow === false && this.initialSeconds < 0 && seconds > 0)) {\n      return this.lastResult;\n    }\n\n    // The ChangeDetector should not call transform again while the new value is being resolved\n    this.changeDetectorRef.detach();\n\n    this.lastSeconds = seconds;\n\n    const timeDiff = createTimeDiff(seconds);\n    const result = (this.lastResult = this.timeDiffGenerator(timeDiff));\n\n    // Make sure the update interval refreshed as well\n    this.currentPeriod = this.updateIntervalGenerator(timeDiff);\n\n    // Reattach the ChangeDetector so that further changes are being transformed\n    this.changeDetectorRef.reattach();\n\n    return result;\n  }\n\n  /**\n   * Validate the Input Value and log a warning per value when it fails\n   *\n   * @param value\n   * @private\n   */\n  private isValidInput(value: TAInput): boolean {\n    const validationResult = validateTAInputType(value);\n\n    if (validationResult === false && this.lastInput !== value) {\n      console.warn(\n        `[TimePastPipe] Invalid Input of type ${typeof value} (${value}).`\n      );\n    }\n\n    this.lastInput = value;\n\n    return validationResult;\n  }\n\n  /**\n   * Clear interval ticker subscription\n   */\n  ngOnDestroy(): void {\n    if (this.intervalSubscription) {\n      this.intervalSubscription.unsubscribe();\n    }\n  }\n}\n\n/**\n * @deprecated Use TimePastPipe instead\n */\nexport const NgTimePastPipePipe = TimePastPipe;\n"]}