@jokio/ts-events
Version:
Various EventEmitter event replacements with synchronous, a-synchronous, and queued events. Made in TypeScript so usable with JavaScript and TypeScript.
115 lines • 12.1 kB
JavaScript
// Copyright © 2015 Rogier Schouten<github@workingcode.ninja>
// License: ISC
'use strict';
Object.defineProperty(exports, "__esModule", { value: true });
var sync_event_1 = require("./sync-event");
/**
* Simple synchronous event queue that needs to be drained manually.
*/
var EventQueue = (function () {
function EventQueue() {
/**
* SyncEvent triggered after an event is added outside of a flush operation.
* @param queue The event queue itself
*/
this.evtFilled = new sync_event_1.SyncEvent();
/**
* SyncEvent triggered after the queue is flushed empty
* @param queue The event queue itself
*/
this.evtDrained = new sync_event_1.SyncEvent();
/**
* Queued elements
*/
this._queue = [];
/**
* True while flush() or flushOnce() is running
*/
this._flushing = false;
}
/**
* The module-global event queue
*/
EventQueue.global = function () {
if (!EventQueue._instance) {
EventQueue.resetGlobal();
}
return EventQueue._instance;
};
/**
* Testing purposes
*/
EventQueue.resetGlobal = function () {
EventQueue._instance = new EventQueue();
};
/**
* Returns true iff the queue is empty
*/
EventQueue.prototype.empty = function () {
return this._queue.length === 0;
};
/**
* Add an element to the queue. The handler is called when one of the flush
* methods is called.
*/
EventQueue.prototype.add = function (handler) {
this._queue.push(handler);
if (this._queue.length === 1 && !this._flushing) {
this.evtFilled.post(this);
}
};
/**
* Calls all handlers currently in the queue. Does not call any handlers added
* as a result of the flush
*/
EventQueue.prototype.flushOnce = function () {
var empty = (this._queue.length === 0);
var flushing = this._flushing;
this._flushing = true;
try {
var queue = this._queue;
this._queue = [];
for (var i = 0; i < queue.length; ++i) {
queue[i]();
}
}
finally {
this._flushing = flushing;
if (!empty && !flushing && this._queue.length === 0) {
this.evtDrained.post(this);
}
}
};
/**
* Flushes the QueuedEvents, calling all events currently in the queue and those
* put into the queue as a result of the flush.
* @param maxRounds Optional, default 10. Number of iterations after which to throw an error because
* the queue keeps filling up. Set to null to disable this.
*/
EventQueue.prototype.flush = function (maxRounds) {
if (maxRounds === void 0) { maxRounds = 10; }
var empty = (this._queue.length === 0);
var flushing = this._flushing;
this._flushing = true;
try {
var i = 0;
while (this._queue.length > 0) {
if (typeof maxRounds === 'number' && i >= maxRounds) {
this._queue = [];
throw new Error('unable to flush the queue due to recursively added event. Clearing queue now');
}
this.flushOnce();
++i;
}
}
finally {
this._flushing = flushing;
if (!empty && !flushing && this._queue.length === 0) {
this.evtDrained.post(this);
}
}
};
return EventQueue;
}());
exports.default = EventQueue;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"EventQueue.js","sourceRoot":"","sources":["../src/lib/EventQueue.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,eAAe;AAEf,YAAY,CAAC;;AAEb,2CAAyC;AAEzC;;GAEG;AACH;IAAA;QAEI;;;WAGG;QACI,cAAS,GAA0B,IAAI,sBAAS,EAAc,CAAC;QACtE;;;WAGG;QACI,eAAU,GAA0B,IAAI,sBAAS,EAAc,CAAC;QAwBvE;;WAEG;QACK,WAAM,GAAmB,EAAE,CAAC;QAEpC;;WAEG;QACK,cAAS,GAAY,KAAK,CAAC;IAqEvC,CAAC;IA9FG;;OAEG;IACW,iBAAM,GAApB;QACI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;YACxB,UAAU,CAAC,WAAW,EAAE,CAAC;QAC7B,CAAC;QACD,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC;IAChC,CAAC;IAED;;OAEG;IACW,sBAAW,GAAzB;QACI,UAAU,CAAC,SAAS,GAAG,IAAI,UAAU,EAAE,CAAC;IAC5C,CAAC;IAYD;;OAEG;IACI,0BAAK,GAAZ;QACI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,wBAAG,GAAV,UAAW,OAAmB;QAC1B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,8BAAS,GAAhB;QACI,IAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QACzC,IAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC;YACD,IAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;YAC1B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;YACjB,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACpC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,CAAC;QACL,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,0BAAK,GAAZ,UAAa,SAAsB;QAAtB,0BAAA,EAAA,cAAsB;QAC/B,IAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QACzC,IAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,EAAE,CAAC,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC;oBAClD,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;gBACpG,CAAC;gBACD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACjB,EAAE,CAAC,CAAC;YACR,CAAC;QACL,CAAC;gBAAS,CAAC;YACP,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;YAC1B,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACL,CAAC;IACL,CAAC;IACL,iBAAC;AAAD,CAAC,AAhHD,IAgHC;AAED,kBAAe,UAAU,CAAC","sourcesContent":["// Copyright © 2015 Rogier Schouten<github@workingcode.ninja>\n// License: ISC\n\n'use strict';\n\nimport { SyncEvent } from './sync-event';\n\n/**\n * Simple synchronous event queue that needs to be drained manually.\n */\nclass EventQueue {\n\n    /**\n     * SyncEvent triggered after an event is added outside of a flush operation.\n     * @param queue The event queue itself\n     */\n    public evtFilled: SyncEvent<EventQueue> = new SyncEvent<EventQueue>();\n    /**\n     * SyncEvent triggered after the queue is flushed empty\n     * @param queue The event queue itself\n     */\n    public evtDrained: SyncEvent<EventQueue> = new SyncEvent<EventQueue>();\n\n    /**\n     * The module-global event queue\n     */\n    private static _instance: EventQueue;\n\n    /**\n     * The module-global event queue\n     */\n    public static global(): EventQueue {\n        if (!EventQueue._instance) {\n            EventQueue.resetGlobal();\n        }\n        return EventQueue._instance;\n    }\n\n    /**\n     * Testing purposes\n     */\n    public static resetGlobal(): void {\n        EventQueue._instance = new EventQueue();\n    }\n\n    /**\n     * Queued elements\n     */\n    private _queue: (() => void)[] = [];\n\n    /**\n     * True while flush() or flushOnce() is running\n     */\n    private _flushing: boolean = false;\n\n    /**\n     * Returns true iff the queue is empty\n     */\n    public empty(): boolean {\n        return this._queue.length === 0;\n    }\n\n    /**\n     * Add an element to the queue. The handler is called when one of the flush\n     * methods is called.\n     */\n    public add(handler: () => void): void {\n        this._queue.push(handler);\n        if (this._queue.length === 1 && !this._flushing) {\n            this.evtFilled.post(this);\n        }\n    }\n\n    /**\n     * Calls all handlers currently in the queue. Does not call any handlers added\n     * as a result of the flush\n     */\n    public flushOnce(): void {\n        const empty = (this._queue.length === 0);\n        const flushing = this._flushing;\n        this._flushing = true;\n        try {\n            const queue = this._queue;\n            this._queue = [];\n            for (let i = 0; i < queue.length; ++i) {\n                queue[i]();\n            }\n        } finally {\n            this._flushing = flushing;\n            if (!empty && !flushing && this._queue.length === 0) {\n                this.evtDrained.post(this);\n            }\n        }\n    }\n\n    /**\n     * Flushes the QueuedEvents, calling all events currently in the queue and those\n     * put into the queue as a result of the flush.\n     * @param maxRounds Optional, default 10. Number of iterations after which to throw an error because\n     *                  the queue keeps filling up. Set to null to disable this.\n     */\n    public flush(maxRounds: number = 10): void {\n        const empty = (this._queue.length === 0);\n        const flushing = this._flushing;\n        this._flushing = true;\n        try {\n            let i = 0;\n            while (this._queue.length > 0) {\n                if (typeof maxRounds === 'number' && i >= maxRounds) {\n                    this._queue = [];\n                    throw new Error('unable to flush the queue due to recursively added event. Clearing queue now');\n                }\n                this.flushOnce();\n                ++i;\n            }\n        } finally {\n            this._flushing = flushing;\n            if (!empty && !flushing && this._queue.length === 0) {\n                this.evtDrained.post(this);\n            }\n        }\n    }\n}\n\nexport default EventQueue;\n"]}