saij
Version:
A learning engine.
164 lines (133 loc) • 12.4 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.unByKey = unByKey;
exports.default = void 0;
var _Target = _interopRequireDefault(require("./Target.js"));
var _EventType = _interopRequireDefault(require("./EventType.js"));
var _events = require("./utils/events.js");
/**
* @module saij/core/Observable
*/
/* eslint max-len: 0 */
/**
* @classdesc
* Abstract base class; normally only used for creating subclasses and not
* instantiated in apps.
* An event target providing convenient methods for listener registration
* and unregistration. A generic `change` event is always available through
* {@link module:saij/core/Observable~Observable#changed}.
*
* @fires module:saij/core/Event~Event
* @api
*/
class Observable extends _Target.default {
constructor() {
super();
/**
* @private
* @type {number}
*/
this.revision_ = 0;
}
/**
* Increases the revision counter and dispatches a 'change' event.
* @api
*/
changed() {
this.revision_ += 1;
this.dispatchEvent(_EventType.default.CHANGE);
}
/**
* Get the version number for this object. Each time the object is modified,
* its version number will be incremented.
* @return {number} Revision.
* @api
*/
getRevision() {
return this.revision_;
}
/**
* Listen for a certain type of event.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
on(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; i += 1) {
keys[i] = (0, _events.listen)(this, type[i], listener);
}
return keys;
}
return (0, _events.listen)(this,
/** @type {string} */
type, listener);
}
/**
* Listen once for a certain type of event.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @return {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} Unique key for the listener. If
* called with an array of event types as the first argument, the return
* will be an array of keys.
* @api
*/
once(type, listener) {
if (Array.isArray(type)) {
const len = type.length;
const keys = new Array(len);
for (let i = 0; i < len; i += 1) {
keys[i] = (0, _events.listenOnce)(this, type[i], listener);
}
return keys;
}
return (0, _events.listenOnce)(this,
/** @type {string} */
type, listener);
}
/**
* Unlisten for a certain type of event.
* @param {string|Array<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @api
*/
un(type, listener) {
if (Array.isArray(type)) {
for (let i = 0, ii = type.length; i < ii; i += 1) {
(0, _events.unlisten)(this, type[i], listener);
}
return;
}
(0, _events.unlisten)(this,
/** @type {string} */
type, listener);
}
}
/**
* Removes an event listener using the key returned by `on()` or `once()`.
* @param {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} key The key returned by `on()`
* or `once()` (or an array of keys).
* @api
*/
function unByKey(key) {
if (Array.isArray(key)) {
for (let i = 0, ii = key.length; i < ii; i += 1) {
(0, _events.unlistenByKey)(key[i]);
}
} else {
(0, _events.unlistenByKey)(
/** @type {module:saij/core/utils/events~EventsKey} */
key);
}
}
var _default = Observable;
exports.default = _default;
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["../../../src/saij/core/Observable.js"],"names":["Observable","EventTarget","constructor","revision_","changed","dispatchEvent","EventType","CHANGE","getRevision","on","type","listener","Array","isArray","len","length","keys","i","once","un","ii","unByKey","key"],"mappings":";;;;;;;;;;AAGA;;AACA;;AACA;;AALA;;;;AAOA;;AAGA;;;;;;;;;;;AAWA,MAAMA,UAAN,SAAyBC,eAAzB,CAAqC;AACnCC,EAAAA,WAAW,GAAG;AAEZ;AAEA;;;;;AAIA,SAAKC,SAAL,GAAiB,CAAjB;AAED;AAED;;;;;;AAIAC,EAAAA,OAAO,GAAG;AACR,SAAKD,SAAL,IAAkB,CAAlB;AACA,SAAKE,aAAL,CAAmBC,mBAAUC,MAA7B;AACD;AAED;;;;;;;;AAMAC,EAAAA,WAAW,GAAG;AACZ,WAAO,KAAKL,SAAZ;AACD;AAED;;;;;;;;;;;AASAM,EAAAA,EAAE,CAACC,IAAD,EAAOC,QAAP,EAAiB;AACjB,QAAIC,KAAK,CAACC,OAAN,CAAcH,IAAd,CAAJ,EAAyB;AACvB,YAAMI,GAAG,GAAGJ,IAAI,CAACK,MAAjB;AACA,YAAMC,IAAI,GAAG,IAAIJ,KAAJ,CAAUE,GAAV,CAAb;;AACA,WAAK,IAAIG,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGH,GAApB,EAAyBG,CAAC,IAAI,CAA9B,EAAiC;AAC/BD,QAAAA,IAAI,CAACC,CAAD,CAAJ,GAAU,oBAAO,IAAP,EAAaP,IAAI,CAACO,CAAD,CAAjB,EAAsBN,QAAtB,CAAV;AACD;;AACD,aAAOK,IAAP;AACD;;AAED,WAAO,oBAAO,IAAP;AAAa;AAAuBN,IAAAA,IAApC,EAA2CC,QAA3C,CAAP;AACD;AAED;;;;;;;;;;;AASAO,EAAAA,IAAI,CAACR,IAAD,EAAOC,QAAP,EAAiB;AACnB,QAAIC,KAAK,CAACC,OAAN,CAAcH,IAAd,CAAJ,EAAyB;AACvB,YAAMI,GAAG,GAAGJ,IAAI,CAACK,MAAjB;AACA,YAAMC,IAAI,GAAG,IAAIJ,KAAJ,CAAUE,GAAV,CAAb;;AACA,WAAK,IAAIG,CAAC,GAAG,CAAb,EAAgBA,CAAC,GAAGH,GAApB,EAAyBG,CAAC,IAAI,CAA9B,EAAiC;AAC/BD,QAAAA,IAAI,CAACC,CAAD,CAAJ,GAAU,wBAAW,IAAX,EAAiBP,IAAI,CAACO,CAAD,CAArB,EAA0BN,QAA1B,CAAV;AACD;;AACD,aAAOK,IAAP;AACD;;AAED,WAAO,wBAAW,IAAX;AAAiB;AAAuBN,IAAAA,IAAxC,EAA+CC,QAA/C,CAAP;AACD;AAED;;;;;;;;AAMAQ,EAAAA,EAAE,CAACT,IAAD,EAAOC,QAAP,EAAiB;AACjB,QAAIC,KAAK,CAACC,OAAN,CAAcH,IAAd,CAAJ,EAAyB;AACvB,WAAK,IAAIO,CAAC,GAAG,CAAR,EAAWG,EAAE,GAAGV,IAAI,CAACK,MAA1B,EAAkCE,CAAC,GAAGG,EAAtC,EAA0CH,CAAC,IAAI,CAA/C,EAAkD;AAChD,8BAAS,IAAT,EAAeP,IAAI,CAACO,CAAD,CAAnB,EAAwBN,QAAxB;AACD;;AACD;AACD;;AAED,0BAAS,IAAT;AAAe;AAAuBD,IAAAA,IAAtC,EAA6CC,QAA7C;AACD;;AA3FkC;AA+FrC;;;;;;;;AAMO,SAASU,OAAT,CAAiBC,GAAjB,EAAsB;AAC3B,MAAIV,KAAK,CAACC,OAAN,CAAcS,GAAd,CAAJ,EAAwB;AACtB,SAAK,IAAIL,CAAC,GAAG,CAAR,EAAWG,EAAE,GAAGE,GAAG,CAACP,MAAzB,EAAiCE,CAAC,GAAGG,EAArC,EAAyCH,CAAC,IAAI,CAA9C,EAAiD;AAC/C,iCAAcK,GAAG,CAACL,CAAD,CAAjB;AACD;AACF,GAJD,MAIO;AACL;AAAc;AAAwDK,IAAAA,GAAtE;AACD;AACF;;eAGctB,U","sourcesContent":["/**\n * @module saij/core/Observable\n */\nimport EventTarget from './Target.js';\nimport EventType from './EventType.js';\nimport {listen, unlistenByKey, unlisten, listenOnce} from './utils/events.js';\n\n/* eslint max-len: 0 */\n\n\n/**\n * @classdesc\n * Abstract base class; normally only used for creating subclasses and not\n * instantiated in apps.\n * An event target providing convenient methods for listener registration\n * and unregistration. A generic `change` event is always available through\n * {@link module:saij/core/Observable~Observable#changed}.\n *\n * @fires module:saij/core/Event~Event\n * @api\n */\nclass Observable extends EventTarget {\n  constructor() {\n\n    super();\n\n    /**\n     * @private\n     * @type {number}\n     */\n    this.revision_ = 0;\n\n  }\n\n  /**\n   * Increases the revision counter and dispatches a 'change' event.\n   * @api\n   */\n  changed() {\n    this.revision_ += 1;\n    this.dispatchEvent(EventType.CHANGE);\n  }\n\n  /**\n   * Get the version number for this object.  Each time the object is modified,\n   * its version number will be incremented.\n   * @return {number} Revision.\n   * @api\n   */\n  getRevision() {\n    return this.revision_;\n  }\n\n  /**\n   * Listen for a certain type of event.\n   * @param {string|Array<string>} type The event type or array of event types.\n   * @param {function(?): ?} listener The listener function.\n   * @return {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} Unique key for the listener. If\n   *     called with an array of event types as the first argument, the return\n   *     will be an array of keys.\n   * @api\n   */\n  on(type, listener) {\n    if (Array.isArray(type)) {\n      const len = type.length;\n      const keys = new Array(len);\n      for (let i = 0; i < len; i += 1) {\n        keys[i] = listen(this, type[i], listener);\n      }\n      return keys;\n    }\n\n    return listen(this, /** @type {string} */ (type), listener);\n  }\n\n  /**\n   * Listen once for a certain type of event.\n   * @param {string|Array<string>} type The event type or array of event types.\n   * @param {function(?): ?} listener The listener function.\n   * @return {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} Unique key for the listener. If\n   *     called with an array of event types as the first argument, the return\n   *     will be an array of keys.\n   * @api\n   */\n  once(type, listener) {\n    if (Array.isArray(type)) {\n      const len = type.length;\n      const keys = new Array(len);\n      for (let i = 0; i < len; i += 1) {\n        keys[i] = listenOnce(this, type[i], listener);\n      }\n      return keys;\n    }\n\n    return listenOnce(this, /** @type {string} */ (type), listener);\n  }\n\n  /**\n   * Unlisten for a certain type of event.\n   * @param {string|Array<string>} type The event type or array of event types.\n   * @param {function(?): ?} listener The listener function.\n   * @api\n   */\n  un(type, listener) {\n    if (Array.isArray(type)) {\n      for (let i = 0, ii = type.length; i < ii; i += 1) {\n        unlisten(this, type[i], listener);\n      }\n      return;\n    }\n\n    unlisten(this, /** @type {string} */ (type), listener);\n  }\n}\n\n\n/**\n * Removes an event listener using the key returned by `on()` or `once()`.\n * @param {module:saij/core/utils/events~EventsKey|Array<module:saij/core/utils/events~EventsKey>} key The key returned by `on()`\n *     or `once()` (or an array of keys).\n * @api\n */\nexport function unByKey(key) {\n  if (Array.isArray(key)) {\n    for (let i = 0, ii = key.length; i < ii; i += 1) {\n      unlistenByKey(key[i]);\n    }\n  } else {\n    unlistenByKey(/** @type {module:saij/core/utils/events~EventsKey} */ (key));\n  }\n}\n\n\nexport default Observable;\n"]}