@omostan/ngx-idle
Version:
A module for responding to idle users in Angular applications. this is a forked version of the original @ng-Idle
118 lines • 12.4 kB
JavaScript
import { EventEmitter, Injectable } from '@angular/core';
import { HttpRequest } from '@angular/common/http';
import { KeepaliveSvc } from '@ng-idle/core';
import * as i0 from "@angular/core";
import * as i1 from "@angular/common/http";
/**
* An example of an injectable service.
*/
export class Keepalive extends KeepaliveSvc {
/*
* Initializes a new instance of Keepalive
* @param http - The HTTP service.
*/
constructor(http, zone) {
super();
this.http = http;
this.zone = zone;
this.pingInterval = 10 * 60;
/*
* An event emitted when the service is pinging.
*/
this.onPing = new EventEmitter();
/*
* An event emitted when the service has pinged an HTTP endpoint and received a response.
*/
this.onPingResponse = new EventEmitter();
}
/*
* Sets the string or Request that should be used when pinging.
* @param url - The URL or Request object to use when pinging.
* @return The current Request used when pinging.
*/
request(url) {
if (typeof url === 'string') {
this.pingRequest = new HttpRequest('GET', url);
}
else if (url instanceof HttpRequest) {
this.pingRequest = url;
}
else if (url === null) {
this.pingRequest = null;
}
return this.pingRequest;
}
/*
* Sets the interval (in seconds) at which the ping operation will occur when start() is called.
* @param seconds - The ping interval in seconds.
* @return The current interval value.
*/
interval(seconds) {
if (!isNaN(seconds) && seconds > 0) {
this.pingInterval = seconds;
}
else if (!isNaN(seconds) && seconds <= 0) {
throw new Error('Interval value must be greater than zero.');
}
return this.pingInterval;
}
/*
* Immediately performs the ping operation. If a request has been set, an HTTP
* request will be made and the response will be emitted via the
* onPingResponse event.
*/
ping() {
this.onPing.emit(null);
if (this.pingRequest) {
this.http.request(this.pingRequest).subscribe((response) => {
this.onPingResponse.emit(response);
}, (error) => {
this.onPingResponse.emit(error);
});
}
}
/*
* Starts pinging on an interval.
*/
start() {
this.stop();
this.zone.runOutsideAngular(() => {
this.pingHandle = setInterval(() => {
this.zone.run(() => {
this.ping();
});
}, this.pingInterval * 1000);
});
}
/*
* Stops pinging on an interval.
*/
stop() {
if (this.hasPingHandle()) {
clearInterval(this.pingHandle);
this.pingHandle = null;
}
}
/*
* Performs any cleanup tasks when Angular destroys the instance.
*/
ngOnDestroy() {
this.stop();
}
/*
* Returns whether or not the service will ping automatically at the specified interval.
* @return True if the service will ping at the specified interval; otherwise, false.
*/
isRunning() {
return this.hasPingHandle();
}
hasPingHandle() {
return this.pingHandle !== null && typeof this.pingHandle !== 'undefined';
}
}
Keepalive.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "14.1.1", ngImport: i0, type: Keepalive, deps: [{ token: i1.HttpClient }, { token: i0.NgZone }], target: i0.ɵɵFactoryTarget.Injectable });
Keepalive.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "14.1.1", ngImport: i0, type: Keepalive });
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "14.1.1", ngImport: i0, type: Keepalive, decorators: [{
type: Injectable
}], ctorParameters: function () { return [{ type: i1.HttpClient }, { type: i0.NgZone }]; } });
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"keepalive.js","sourceRoot":"","sources":["../../../../projects/keepalive/src/lib/keepalive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAqB,MAAM,eAAe,CAAC;AAC5E,OAAO,EAAc,WAAW,EAAgB,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;;;AAE7C;;GAEG;AAEH,MAAM,OAAO,SAAU,SAAQ,YAAY;IAiBzC;;;OAGG;IACH,YAAoB,IAAgB,EAAU,IAAY;QACxD,KAAK,EAAE,CAAC;QADU,SAAI,GAAJ,IAAI,CAAY;QAAU,SAAI,GAAJ,IAAI,CAAQ;QAnBlD,iBAAY,GAAW,EAAE,GAAG,EAAE,CAAC;QAGvC;;WAEG;QACI,WAAM,GAAsB,IAAI,YAAY,EAAE,CAAC;QAEtD;;WAEG;QACI,mBAAc,GAAoC,IAAI,YAAY,EAEtE,CAAC;IAQJ,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAI,GAA6B;QACtC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,WAAW,GAAG,IAAI,WAAW,CAAI,KAAK,EAAE,GAAG,CAAC,CAAC;SACnD;aAAM,IAAI,GAAG,YAAY,WAAW,EAAE;YACrC,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;SACxB;aAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;SACzB;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,OAAgB;QACvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE;YAClC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;SAC7B;aAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,IAAI,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;SAC9D;QAED,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAC3C,CAAC,QAA2B,EAAE,EAAE;gBAC9B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,CAAC,EACD,CAAC,KAAwB,EAAE,EAAE;gBAC3B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC,CACF,CAAC;SACH;IACH,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;QAEZ,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE;YAC/B,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;gBACjC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE;oBACjB,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,CAAC,CAAC,CAAC;YACL,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,aAAa,EAAE,EAAE;YACxB,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SACxB;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;IAC9B,CAAC;IAEO,aAAa;QACnB,OAAO,IAAI,CAAC,UAAU,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC;IAC5E,CAAC;;sGAtHU,SAAS;0GAAT,SAAS;2FAAT,SAAS;kBADrB,UAAU","sourcesContent":["import { EventEmitter, Injectable, NgZone, OnDestroy } from '@angular/core';\r\nimport { HttpClient, HttpRequest, HttpResponse } from '@angular/common/http';\r\nimport { KeepaliveSvc } from '@ng-idle/core';\r\n\r\n/**\r\n * An example of an injectable service.\r\n */\r\n@Injectable()\r\nexport class Keepalive extends KeepaliveSvc implements OnDestroy {\r\n  private pingRequest: HttpRequest<any>;\r\n  private pingInterval: number = 10 * 60;\r\n  private pingHandle: any;\r\n\r\n  /*\r\n   * An event emitted when the service is pinging.\r\n   */\r\n  public onPing: EventEmitter<any> = new EventEmitter();\r\n\r\n  /*\r\n   * An event emitted when the service has pinged an HTTP endpoint and received a response.\r\n   */\r\n  public onPingResponse: EventEmitter<HttpResponse<any>> = new EventEmitter<\r\n    HttpResponse<any>\r\n  >();\r\n\r\n  /*\r\n   * Initializes a new instance of Keepalive\r\n   * @param http - The HTTP service.\r\n   */\r\n  constructor(private http: HttpClient, private zone: NgZone) {\r\n    super();\r\n  }\r\n\r\n  /*\r\n   * Sets the string or Request that should be used when pinging.\r\n   * @param url - The URL or Request object to use when pinging.\r\n   * @return The current Request used when pinging.\r\n   */\r\n  request<T>(url?: string | HttpRequest<T>): HttpRequest<T> {\r\n    if (typeof url === 'string') {\r\n      this.pingRequest = new HttpRequest<T>('GET', url);\r\n    } else if (url instanceof HttpRequest) {\r\n      this.pingRequest = url;\r\n    } else if (url === null) {\r\n      this.pingRequest = null;\r\n    }\r\n\r\n    return this.pingRequest;\r\n  }\r\n\r\n  /*\r\n   * Sets the interval (in seconds) at which the ping operation will occur when start() is called.\r\n   * @param seconds - The ping interval in seconds.\r\n   * @return The current interval value.\r\n   */\r\n  interval(seconds?: number): number {\r\n    if (!isNaN(seconds) && seconds > 0) {\r\n      this.pingInterval = seconds;\r\n    } else if (!isNaN(seconds) && seconds <= 0) {\r\n      throw new Error('Interval value must be greater than zero.');\r\n    }\r\n\r\n    return this.pingInterval;\r\n  }\r\n\r\n  /*\r\n   * Immediately performs the ping operation. If a request has been set, an HTTP\r\n   * request will be made and the response will be emitted via the\r\n   * onPingResponse event.\r\n   */\r\n  ping(): void {\r\n    this.onPing.emit(null);\r\n    if (this.pingRequest) {\r\n      this.http.request(this.pingRequest).subscribe(\r\n        (response: HttpResponse<any>) => {\r\n          this.onPingResponse.emit(response);\r\n        },\r\n        (error: HttpResponse<any>) => {\r\n          this.onPingResponse.emit(error);\r\n        }\r\n      );\r\n    }\r\n  }\r\n\r\n  /*\r\n   * Starts pinging on an interval.\r\n   */\r\n  start(): void {\r\n    this.stop();\r\n\r\n    this.zone.runOutsideAngular(() => {\r\n      this.pingHandle = setInterval(() => {\r\n        this.zone.run(() => {\r\n          this.ping();\r\n        });\r\n      }, this.pingInterval * 1000);\r\n    });\r\n  }\r\n\r\n  /*\r\n   * Stops pinging on an interval.\r\n   */\r\n  stop(): void {\r\n    if (this.hasPingHandle()) {\r\n      clearInterval(this.pingHandle);\r\n      this.pingHandle = null;\r\n    }\r\n  }\r\n\r\n  /*\r\n   * Performs any cleanup tasks when Angular destroys the instance.\r\n   */\r\n  ngOnDestroy(): void {\r\n    this.stop();\r\n  }\r\n\r\n  /*\r\n   * Returns whether or not the service will ping automatically at the specified interval.\r\n   * @return True if the service will ping at the specified interval; otherwise, false.\r\n   */\r\n  isRunning(): boolean {\r\n    return this.hasPingHandle();\r\n  }\r\n\r\n  private hasPingHandle(): boolean {\r\n    return this.pingHandle !== null && typeof this.pingHandle !== 'undefined';\r\n  }\r\n}\r\n"]}