async-interval-job
Version:
setInterval for promises and async functions. Support graceful shutdown and prevent multiple executions from overlapping in time.
201 lines • 8.68 kB
JavaScript
"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.validateOptions = exports.validateIntervalMs = exports.validateHandler = exports.AsyncIntervalJob = void 0;
var nodejs_timer_1 = require("nodejs-timer");
var AsyncIntervalJob = /** @class */ (function () {
/**
* Construtor of AsyncIntervalJob
* @param handler `MUST` Function to execute for each interval.
* @param intervalMs `MUST` Millisecond to wait between each function execution.
* @param options {AsyncIntervalJobOptions} `OPTIONAL`
*/
function AsyncIntervalJob(handler, intervalMs, options) {
var _this = this;
validateHandler(handler);
validateIntervalMs(intervalMs);
validateOptions(options);
var defaultOptions = {
autoStart: false,
stopOnError: false,
runImmediately: false,
};
this._handler = handler;
this._intervalMs = intervalMs;
this._options = Object.assign(defaultOptions, options);
this._timer = new nodejs_timer_1.Timer(function () {
_this._loop();
});
this._isHandling = false;
this._isBeforeStop = false;
this._stopCallbacks = [];
if (this._options.autoStart)
this.start();
}
/**
* Start the Job
*/
AsyncIntervalJob.prototype.start = function () {
if (this._isLooping)
return;
if (this._options.runImmediately)
this._loop();
else
this._timer.start(this._intervalMs);
};
/**
* Stop the job.
* @returns Promise -
* If job isn't handling, will clear the interval and resolve the returned promise.
* Otherwise, will wait until the handling finish and resolve the returned promise.
*/
AsyncIntervalJob.prototype.stop = function () {
var _this = this;
return new Promise(function (resolve) {
if (!_this._isLooping)
return resolve();
if (_this._isWaitForNextHandle) {
_this._timer.clear();
return resolve();
}
_this._isBeforeStop = true;
_this._stopCallbacks.push(resolve);
});
};
/**
* Get current state of the interval job
* @returns {AsyncIntervalJobState}
*/
AsyncIntervalJob.prototype.getState = function () {
return {
isHandling: this._isHandling,
isWaitForNextHandle: this._isWaitForNextHandle,
isBeforeStop: this._isBeforeStop,
};
};
Object.defineProperty(AsyncIntervalJob.prototype, "_isWaitForNextHandle", {
get: function () {
return this._timer.isRunning();
},
enumerable: false,
configurable: true
});
Object.defineProperty(AsyncIntervalJob.prototype, "_isLooping", {
get: function () {
return this._isWaitForNextHandle || this._isHandling;
},
enumerable: false,
configurable: true
});
AsyncIntervalJob.prototype._loop = function () {
return __awaiter(this, void 0, void 0, function () {
var error_1, callback;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, 3, 4]);
return [4 /*yield*/, this._run()];
case 1:
_a.sent();
if (!this._isBeforeStop)
this._timer.start(this._intervalMs);
return [3 /*break*/, 4];
case 2:
error_1 = _a.sent();
if (!this._isBeforeStop && !this._options.stopOnError)
this._timer.start(this._intervalMs);
return [3 /*break*/, 4];
case 3:
this._isBeforeStop = false;
while (this._stopCallbacks.length) {
callback = this._stopCallbacks.pop();
if (callback)
callback();
}
return [7 /*endfinally*/];
case 4: return [2 /*return*/];
}
});
});
};
AsyncIntervalJob.prototype._run = function () {
var _this = this;
this._isHandling = true;
return Promise.resolve(this._handler()).finally(function () {
_this._isHandling = false;
});
};
return AsyncIntervalJob;
}());
exports.AsyncIntervalJob = AsyncIntervalJob;
// @internal
function validateHandler(val) {
if (typeof val !== 'function')
throw new TypeError('Invalid "handler". must be a function');
}
exports.validateHandler = validateHandler;
// @internal
function validateIntervalMs(val) {
if (typeof val !== 'number' || !Number.isInteger(val) || val <= 0)
throw new TypeError('Invalid "intervalMs". must be a positive integer');
}
exports.validateIntervalMs = validateIntervalMs;
// @internal
function validateOptions(val) {
if (typeof val === 'undefined')
return;
if (typeof val !== 'object' || val === null)
throw new TypeError('Invalid "options". must be an object');
if ('autoStart' in val) {
var autoStart = val.autoStart;
if (typeof autoStart !== 'boolean' && typeof autoStart !== 'undefined')
throw new TypeError('Invalid "options.autoStart". must be a boolean');
}
if ('runImmediately' in val) {
var runImmediately = val.runImmediately;
if (typeof runImmediately !== 'boolean' && typeof runImmediately !== 'undefined')
throw new TypeError('Invalid "options.runImmediately". must be a boolean');
}
if ('stopOnError' in val) {
var stopOnError = val.stopOnError;
if (typeof stopOnError !== 'boolean' && typeof stopOnError !== 'undefined')
throw new TypeError('Invalid "options.stopOnError". must be a boolean');
}
}
exports.validateOptions = validateOptions;
//# sourceMappingURL=index.js.map