feat(clock): rename register to tick

README.md

@@ -174,15 +174,15 @@ export class AppModule { }
 
 #### Write your own clock
 
-The only required method to build your own clock, is `register` that must return an `Observable<any>`. Whenever this observable emits, the timestamp will be updated, using your formatter (and intl, if available).
+The only required method to build your own clock, is `tick` that must return an `Observable<any>`. Whenever this observable emits, the timestamp will be updated, using your formatter (and intl, if available).
 
 ```ts
 import { TimeagoClock } from 'ngx-timeago';
 import { Observable, interval } from 'rxjs';
 
 // ticks every 2s
 export class MyClock extends TimeagoClock {
-  register(then: number): Observable<number> {
+  tick(then: number): Observable<number> {
     return interval(2000);
   }
 }

demo/app/app.module.ts

@@ -10,7 +10,7 @@ import { AppComponent } from './app.component';
 import { AppRoutingModule } from './app-routing.module';
 
 export class MyClock extends TimeagoClock {
-  register(then: number): Observable<number> {
+  tick(then: number): Observable<number> {
     return of(0)
     .pipe(
       expand(() => {

lib/src/timeago.clock.ts

@@ -4,12 +4,12 @@ import { expand, delay, skip } from 'rxjs/operators';
 import { MINUTE, HOUR, DAY, WEEK, MONTH, YEAR } from './util';
 
 export abstract class TimeagoClock {
-  abstract register(then: number): Observable<any>;
+  abstract tick(then: number): Observable<any>;
 }
 
 @Injectable()
 export class TimeagoDefaultClock extends TimeagoClock {
-  register(then: number): Observable<number> {
+  tick(then: number): Observable<number> {
     return of(0)
       .pipe(
         expand(() => {

lib/src/timeago.directive.ts

@@ -40,7 +40,7 @@ export class TimeagoDirective implements OnChanges, OnDestroy {
       if (this.clockSubscription) {
         this.clockSubscription.unsubscribe();
       }
-      this.clockSubscription = this.clock.register(date)
+      this.clockSubscription = this.clock.tick(date)
         .pipe(filter(() => this.live, this))
         .subscribe(() => this.stateChanges.next());
     } else {

tests/clock.spec.ts

@@ -22,7 +22,7 @@ describe('TimeagoClock', () => {
 
     it('should complete instantly for differences greater than a day', (() => {
       testScheduler.run(({ expectObservable }) => {
-        const source = clock.register(Date.now() - 60 * 60 * 24 * 1000).pipe(map(x => x.toString()));
+        const source = clock.tick(Date.now() - 60 * 60 * 24 * 1000).pipe(map(x => x.toString()));
         const expected = '|';
         expectObservable(source).toBe(expected);
       });