matrix-react-sdk
Version:
SDK for matrix.org using React
124 lines (115 loc) • 12 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _utils = require("matrix-js-sdk/src/utils");
/*
Copyright 2024 New Vector Ltd.
Copyright 2018-2021 The Matrix.org Foundation C.I.C.
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
Please see LICENSE files in the repository root for full details.
*/
/**
A countdown timer, exposing a promise api.
A timer starts in a non-started state,
and needs to be started by calling `start()`` on it first.
Timers can be `abort()`-ed which makes the promise reject prematurely.
Once a timer is finished or aborted, it can't be started again
(because the promise should not be replaced). Instead, create
a new one through `clone()` or `cloneIfRun()`.
*/
class Timer {
constructor(timeout) {
(0, _defineProperty2.default)(this, "timerHandle", void 0);
(0, _defineProperty2.default)(this, "startTs", void 0);
(0, _defineProperty2.default)(this, "deferred", void 0);
(0, _defineProperty2.default)(this, "onTimeout", () => {
const now = Date.now();
const elapsed = now - this.startTs;
if (elapsed >= this.timeout) {
this.deferred.resolve();
this.setNotStarted();
} else {
const delta = this.timeout - elapsed;
this.timerHandle = window.setTimeout(this.onTimeout, delta);
}
});
this.timeout = timeout;
this.setNotStarted();
}
setNotStarted() {
this.timerHandle = undefined;
this.startTs = undefined;
this.deferred = (0, _utils.defer)();
this.deferred.promise = this.deferred.promise.finally(() => {
this.timerHandle = undefined;
});
}
changeTimeout(timeout) {
if (timeout === this.timeout) {
return;
}
const isSmallerTimeout = timeout < this.timeout;
this.timeout = timeout;
if (this.isRunning() && isSmallerTimeout) {
clearTimeout(this.timerHandle);
this.onTimeout();
}
}
/**
* if not started before, starts the timer.
* @returns {Timer} the same timer
*/
start() {
if (!this.isRunning()) {
this.startTs = Date.now();
this.timerHandle = window.setTimeout(this.onTimeout, this.timeout);
}
return this;
}
/**
* (re)start the timer. If it's running, reset the timeout. If not, start it.
* @returns {Timer} the same timer
*/
restart() {
if (this.isRunning()) {
// don't clearTimeout here as this method
// can be called in fast succession,
// instead just take note and compare
// when the already running timeout expires
this.startTs = Date.now();
return this;
} else {
return this.start();
}
}
/**
* if the timer is running, abort it,
* and reject the promise for this timer.
* @returns {Timer} the same timer
*/
abort() {
if (this.isRunning()) {
clearTimeout(this.timerHandle);
this.deferred.reject(new Error("Timer was aborted."));
this.setNotStarted();
}
return this;
}
/**
*promise that will resolve when the timer elapses,
*or is rejected when abort is called
*@return {Promise}
*/
finished() {
return this.deferred.promise;
}
isRunning() {
return this.timerHandle !== undefined;
}
}
exports.default = Timer;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"names":["_utils","require","Timer","constructor","timeout","_defineProperty2","default","now","Date","elapsed","startTs","deferred","resolve","setNotStarted","delta","timerHandle","window","setTimeout","onTimeout","undefined","defer","promise","finally","changeTimeout","isSmallerTimeout","isRunning","clearTimeout","start","restart","abort","reject","Error","finished","exports"],"sources":["../../src/utils/Timer.ts"],"sourcesContent":["/*\nCopyright 2024 New Vector Ltd.\nCopyright 2018-2021 The Matrix.org Foundation C.I.C.\n\nSPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only\nPlease see LICENSE files in the repository root for full details.\n*/\n\nimport { IDeferred, defer } from \"matrix-js-sdk/src/utils\";\n\n/**\nA countdown timer, exposing a promise api.\nA timer starts in a non-started state,\nand needs to be started by calling `start()`` on it first.\n\nTimers can be `abort()`-ed which makes the promise reject prematurely.\n\nOnce a timer is finished or aborted, it can't be started again\n(because the promise should not be replaced). Instead, create\na new one through `clone()` or `cloneIfRun()`.\n*/\nexport default class Timer {\n    private timerHandle?: number;\n    private startTs?: number;\n    private deferred!: IDeferred<void>;\n\n    public constructor(private timeout: number) {\n        this.setNotStarted();\n    }\n\n    private setNotStarted(): void {\n        this.timerHandle = undefined;\n        this.startTs = undefined;\n        this.deferred = defer();\n        this.deferred.promise = this.deferred.promise.finally(() => {\n            this.timerHandle = undefined;\n        });\n    }\n\n    private onTimeout = (): void => {\n        const now = Date.now();\n        const elapsed = now - this.startTs!;\n        if (elapsed >= this.timeout) {\n            this.deferred.resolve();\n            this.setNotStarted();\n        } else {\n            const delta = this.timeout - elapsed;\n            this.timerHandle = window.setTimeout(this.onTimeout, delta);\n        }\n    };\n\n    public changeTimeout(timeout: number): void {\n        if (timeout === this.timeout) {\n            return;\n        }\n        const isSmallerTimeout = timeout < this.timeout;\n        this.timeout = timeout;\n        if (this.isRunning() && isSmallerTimeout) {\n            clearTimeout(this.timerHandle);\n            this.onTimeout();\n        }\n    }\n\n    /**\n     * if not started before, starts the timer.\n     * @returns {Timer} the same timer\n     */\n    public start(): Timer {\n        if (!this.isRunning()) {\n            this.startTs = Date.now();\n            this.timerHandle = window.setTimeout(this.onTimeout, this.timeout);\n        }\n        return this;\n    }\n\n    /**\n     * (re)start the timer. If it's running, reset the timeout. If not, start it.\n     * @returns {Timer} the same timer\n     */\n    public restart(): Timer {\n        if (this.isRunning()) {\n            // don't clearTimeout here as this method\n            // can be called in fast succession,\n            // instead just take note and compare\n            // when the already running timeout expires\n            this.startTs = Date.now();\n            return this;\n        } else {\n            return this.start();\n        }\n    }\n\n    /**\n     * if the timer is running, abort it,\n     * and reject the promise for this timer.\n     * @returns {Timer} the same timer\n     */\n    public abort(): Timer {\n        if (this.isRunning()) {\n            clearTimeout(this.timerHandle);\n            this.deferred.reject(new Error(\"Timer was aborted.\"));\n            this.setNotStarted();\n        }\n        return this;\n    }\n\n    /**\n     *promise that will resolve when the timer elapses,\n     *or is rejected when abort is called\n     *@return {Promise}\n     */\n    public finished(): Promise<void> {\n        return this.deferred.promise;\n    }\n\n    public isRunning(): boolean {\n        return this.timerHandle !== undefined;\n    }\n}\n"],"mappings":";;;;;;;;AAQA,IAAAA,MAAA,GAAAC,OAAA;AARA;AACA;AACA;AACA;AACA;AACA;AACA;;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,MAAMC,KAAK,CAAC;EAKhBC,WAAWA,CAASC,OAAe,EAAE;IAAA,IAAAC,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA;IAAA,IAAAD,gBAAA,CAAAC,OAAA,qBAaxB,MAAY;MAC5B,MAAMC,GAAG,GAAGC,IAAI,CAACD,GAAG,CAAC,CAAC;MACtB,MAAME,OAAO,GAAGF,GAAG,GAAG,IAAI,CAACG,OAAQ;MACnC,IAAID,OAAO,IAAI,IAAI,CAACL,OAAO,EAAE;QACzB,IAAI,CAACO,QAAQ,CAACC,OAAO,CAAC,CAAC;QACvB,IAAI,CAACC,aAAa,CAAC,CAAC;MACxB,CAAC,MAAM;QACH,MAAMC,KAAK,GAAG,IAAI,CAACV,OAAO,GAAGK,OAAO;QACpC,IAAI,CAACM,WAAW,GAAGC,MAAM,CAACC,UAAU,CAAC,IAAI,CAACC,SAAS,EAAEJ,KAAK,CAAC;MAC/D;IACJ,CAAC;IAAA,KAvB0BV,OAAe,GAAfA,OAAe;IACtC,IAAI,CAACS,aAAa,CAAC,CAAC;EACxB;EAEQA,aAAaA,CAAA,EAAS;IAC1B,IAAI,CAACE,WAAW,GAAGI,SAAS;IAC5B,IAAI,CAACT,OAAO,GAAGS,SAAS;IACxB,IAAI,CAACR,QAAQ,GAAG,IAAAS,YAAK,EAAC,CAAC;IACvB,IAAI,CAACT,QAAQ,CAACU,OAAO,GAAG,IAAI,CAACV,QAAQ,CAACU,OAAO,CAACC,OAAO,CAAC,MAAM;MACxD,IAAI,CAACP,WAAW,GAAGI,SAAS;IAChC,CAAC,CAAC;EACN;EAcOI,aAAaA,CAACnB,OAAe,EAAQ;IACxC,IAAIA,OAAO,KAAK,IAAI,CAACA,OAAO,EAAE;MAC1B;IACJ;IACA,MAAMoB,gBAAgB,GAAGpB,OAAO,GAAG,IAAI,CAACA,OAAO;IAC/C,IAAI,CAACA,OAAO,GAAGA,OAAO;IACtB,IAAI,IAAI,CAACqB,SAAS,CAAC,CAAC,IAAID,gBAAgB,EAAE;MACtCE,YAAY,CAAC,IAAI,CAACX,WAAW,CAAC;MAC9B,IAAI,CAACG,SAAS,CAAC,CAAC;IACpB;EACJ;;EAEA;AACJ;AACA;AACA;EACWS,KAAKA,CAAA,EAAU;IAClB,IAAI,CAAC,IAAI,CAACF,SAAS,CAAC,CAAC,EAAE;MACnB,IAAI,CAACf,OAAO,GAAGF,IAAI,CAACD,GAAG,CAAC,CAAC;MACzB,IAAI,CAACQ,WAAW,GAAGC,MAAM,CAACC,UAAU,CAAC,IAAI,CAACC,SAAS,EAAE,IAAI,CAACd,OAAO,CAAC;IACtE;IACA,OAAO,IAAI;EACf;;EAEA;AACJ;AACA;AACA;EACWwB,OAAOA,CAAA,EAAU;IACpB,IAAI,IAAI,CAACH,SAAS,CAAC,CAAC,EAAE;MAClB;MACA;MACA;MACA;MACA,IAAI,CAACf,OAAO,GAAGF,IAAI,CAACD,GAAG,CAAC,CAAC;MACzB,OAAO,IAAI;IACf,CAAC,MAAM;MACH,OAAO,IAAI,CAACoB,KAAK,CAAC,CAAC;IACvB;EACJ;;EAEA;AACJ;AACA;AACA;AACA;EACWE,KAAKA,CAAA,EAAU;IAClB,IAAI,IAAI,CAACJ,SAAS,CAAC,CAAC,EAAE;MAClBC,YAAY,CAAC,IAAI,CAACX,WAAW,CAAC;MAC9B,IAAI,CAACJ,QAAQ,CAACmB,MAAM,CAAC,IAAIC,KAAK,CAAC,oBAAoB,CAAC,CAAC;MACrD,IAAI,CAAClB,aAAa,CAAC,CAAC;IACxB;IACA,OAAO,IAAI;EACf;;EAEA;AACJ;AACA;AACA;AACA;EACWmB,QAAQA,CAAA,EAAkB;IAC7B,OAAO,IAAI,CAACrB,QAAQ,CAACU,OAAO;EAChC;EAEOI,SAASA,CAAA,EAAY;IACxB,OAAO,IAAI,CAACV,WAAW,KAAKI,SAAS;EACzC;AACJ;AAACc,OAAA,CAAA3B,OAAA,GAAAJ,KAAA","ignoreList":[]}