grainjs 1.0.1 → 1.1.0

package/dist/cjs/lib/obsArray.js

@@ -1,44 +1,30 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveIndex = exports.makeLiveIndex = exports.computedArray = exports.ComputedArray = exports.obsArray = exports.MutableObsArray = exports.ObsArray = void 0;
+const dispose_1 = require("./dispose");
+const observable_1 = require("./observable");
+const subscribe_1 = require("./subscribe");
 /**
- * ObsArray extends a plain Observable to allow for more efficient observation of array changes.
+ * `ObsArray<T>` is essentially an array-valued observable. It extends a plain Observable to allow
+ * for more efficient observation of array changes. It also may be
+ * used as an owner for disposable array elements.
  *
- * As for any array-valued Observable, when the contents of the observed array changes, the
+ * As for any array-valued `Observable`, when the contents of the observed array changes, the
  * listeners get called with new and previous values which are the same array. For simple changes,
- * such as those made with .push() and .splice() methods, ObsArray allows for more efficient
+ * such as those made with `.push()` and `.splice()` methods, `ObsArray` allows for more efficient
  * handling of the change by calling listeners with splice info in the third argument.
  *
- * This module also provides computedArray(), which allows mapping each item of an ObsArray
- * through a function, passing through splice info for efficient handling of small changes. It
- * also allows mapping an observable or a computed whose value is an ObsArray.
- *
- * There is no need or benefit in using computedArray() if you have a computed() that returns a
- * plain array. It is specifically for the case when you want to preserve the efficiency of
- * ObsArray when you map its values.
- *
- * Both ObsArray and ComputedArray may be used with disposable elements as their owners. E.g.
+ * `ObsArray` may be used with disposable elements as their owner. E.g.
+ * ```ts
+ * const arr = obsArray<D>();
+ * arr.push(D.create(arr, "x"), D.create(arr, "y"));
+ * arr.pop();      // Element "y" gets disposed.
+ * arr.dispose();  // Element "x" gets disposed.
+ * ```
  *
- *    const arr = obsArray<D>();
- *    arr.push(D.create(arr, "x"), D.create(arr, "y"));
- *    arr.pop();      // Element "y" gets disposed.
- *    arr.dispose();  // Element "x" gets disposed.
- *
- *    const values = obsArray<string>();
- *    const compArr = computedArray<D>(values, (val, i, compArr) => D.create(compArr, val));
- *    values.push("foo", "bar");      // D("foo") and D("bar") get created
- *    values.pop();                   // D("bar") gets disposed.
- *    compArr.dispose();              // D("foo") gets disposed.
- *
- * Note that only the pattern above works: obsArray (or compArray) may only be used to take
+ * Note that only the pattern above works: `obsArray` may only be used to take
  * ownership of those disposables that are added to it as array elements.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-const dispose_1 = require("./dispose");
-const observable_1 = require("./observable");
-const subscribe_1 = require("./subscribe");
-/**
- * ObsArray<T> is essentially an array-valued observable. The main difference is that it may be
- * used as an owner for disposable array elements.
- */
 class ObsArray extends observable_1.BaseObservable {
     constructor() {
         super(...arguments);
@@ -47,6 +33,10 @@ class ObsArray extends observable_1.BaseObservable {
     addListener(callback, optContext) {
         return super.addListener(callback, optContext);
     }
+    /**
+     * Take ownership of an item added to this array. This should _only_ be used for array elements,
+     * not any unrelated items.
+     */
     autoDispose(value) {
         if (!this._ownedItems) {
             this._ownedItems = new Set();
@@ -54,6 +44,7 @@ class ObsArray extends observable_1.BaseObservable {
         this._ownedItems.add(value);
         return value;
     }
+    /** @override */
     dispose() {
         if (this._ownedItems) {
             for (const item of this.get()) {
@@ -65,9 +56,11 @@ class ObsArray extends observable_1.BaseObservable {
         }
         super.dispose();
     }
+    /** @internal */
     _setWithSplice(value, splice) {
         return this._setWithArg(value, splice);
     }
+    /** @internal */
     _disposeOwned(splice) {
         if (!this._ownedItems) {
             return;
@@ -97,10 +90,11 @@ class ObsArray extends observable_1.BaseObservable {
 }
 exports.ObsArray = ObsArray;
 /**
- * MutableObsArray<T> adds array-like mutation methods which emit events with splice info, to
- * allow more efficient processing of such changes. It is created with obsArray<T>().
+ * `MutableObsArray<T>` adds array-like mutation methods which emit events with splice info, to
+ * allow more efficient processing of such changes. It is created with `obsArray<T>()`.
  */
 class MutableObsArray extends ObsArray {
+    /** Appends elements to the end and returns the new length (like `Array#push`). */
     push(...args) {
         const value = this.get();
         const start = value.length;
@@ -108,6 +102,7 @@ class MutableObsArray extends ObsArray {
         this._setWithSplice(value, { start, numAdded: args.length, deleted: [] });
         return newLen;
     }
+    /** Removes and returns the last element (like `Array#pop`). */
     pop() {
         const value = this.get();
         if (value.length === 0) {
@@ -117,12 +112,14 @@ class MutableObsArray extends ObsArray {
         this._setWithSplice(value, { start: value.length, numAdded: 0, deleted: [ret] });
         return ret;
     }
+    /** Prepends elements to the start and returns the new length (like `Array#unshift`). */
     unshift(...args) {
         const value = this.get();
         const newLen = value.unshift(...args);
         this._setWithSplice(value, { start: 0, numAdded: args.length, deleted: [] });
         return newLen;
     }
+    /** Removes and returns the first element (like `Array#shift`). */
     shift() {
         const value = this.get();
         if (value.length === 0) {
@@ -132,6 +129,10 @@ class MutableObsArray extends ObsArray {
         this._setWithSplice(value, { start: 0, numAdded: 0, deleted: [ret] });
         return ret;
     }
+    /**
+     * Removes and/or inserts elements at a given index and returns the removed elements (like
+     * `Array#splice`).
+     */
     splice(start, deleteCount = Infinity, ...newValues) {
         const value = this.get();
         const len = value.length;
@@ -144,7 +145,7 @@ class MutableObsArray extends ObsArray {
 exports.MutableObsArray = MutableObsArray;
 /**
  * Creates a new MutableObsArray with an optional initial value, defaulting to the empty array.
- * It is essentially the same as observable<T[]>, but with array-like mutation methods.
+ * It is essentially the same as `observable<T[]>`, but with array-like mutation methods.
  */
 function obsArray(value = []) {
     return new MutableObsArray(value);
@@ -157,16 +158,17 @@ function isObsArray(val) {
     return Array.isArray(val.get());
 }
 /**
- * See computedArray() below for documentation.
+ * See [`computedArray()`](#computedArray) for documentation.
  */
 class ComputedArray extends ObsArray {
     constructor(obsArr, _mapper) {
         super([]);
         this._mapper = _mapper;
         this._sub = isObsArray(obsArr) ?
-            subscribe_1.subscribe(obsArr, (use) => this._syncMap(obsArr)) :
-            subscribe_1.subscribe(obsArr, (use, obsArrayValue) => { use(obsArrayValue); return this._syncMap(obsArrayValue); });
+            (0, subscribe_1.subscribe)(obsArr, (use) => this._syncMap(obsArr)) :
+            (0, subscribe_1.subscribe)(obsArr, (use, obsArrayValue) => { use(obsArrayValue); return this._syncMap(obsArrayValue); });
     }
+    /** @internal */
     dispose() {
         this._unsync();
         this._sub.dispose();
@@ -223,25 +225,43 @@ class ComputedArray extends ObsArray {
 }
 exports.ComputedArray = ComputedArray;
 /**
- * Returns an ObsArray that maps all elements of the passed-in ObsArray through a mapper function.
- * Also accepts an observable (e.g. a computed) whose value is an ObsArray. Usage:
+ * Returns an `ObsArray` that maps all elements of the passed-in `ObsArray` through a mapper
+ * function. Also accepts an observable (e.g. a computed) whose value is an `ObsArray`.
+ * ```ts
+ * computedArray(obsArray, mapper)
+ * ```
  *
- *    computedArray(obsArray, mapper)
+ * The result is analogous to:
+ * ```ts
+ * computed((use) => use(obsArray).map(mapper))       // for ObsArray
+ * computed((use) => use(use(obsArray)).map(mapper))  // for Observable<ObsArray>
+ * ```
  *
- * The result is entirely analogous to:
- *
- *     computed((use) => use(obsArray).map(mapper))       // for ObsArray
- *     computed((use) => use(use(obsArray)).map(mapper))  // for Observable<ObsArray>
- *
- * The benefit of computedArray() is that a small change to the source array (e.g. one item
+ * The benefit of `computedArray()` is that a small change to the source array (e.g. one item
  * added or removed), causes a small change to the mapped array, rather than a full rebuild.
  *
- * This is useful with an ObsArray or with an observable whose value is an ObsArray, and also
- * when the computed array owns its disposable items.
+ * This is useful with an `ObsArray` or with an observable whose value is an `ObsArray`, and also
+ * when the computed array's items are disposable and it owns them.
+ *
+ * There is no need or benefit to using `computedArray()` if you have a `computed()` that returns
+ * a plain array. It is specifically for the case when you want to preserve the efficiency of
+ * `ObsArray` when you map its values.
  *
- * Note that the mapper function is called with (item, index, array) as for a standard
- * array.map(), but that the index is only accurate at the time of the call, and will stop
+ * Note that the mapper function is called with `(item, index, array)` as for a standard
+ * `array.map()`, but that the index is only accurate at the time of the call, and will stop
  * reflecting the true index if more items are inserted into the array later.
+ *
+ * As with `ObsArray`, a `ComputedArray` may be used with disposable elements as their owners. E.g.
+ * ```ts
+ * const values = obsArray<string>();
+ * const compArr = computedArray<D>(values, (val, i, compArr) => D.create(compArr, val));
+ * values.push("foo", "bar");      // D("foo") and D("bar") get created
+ * values.pop();                   // D("bar") gets disposed.
+ * compArr.dispose();              // D("foo") gets disposed.
+ * ```
+ *
+ * Note that only the pattern above works: obsArray (or compArray) may only be used to take
+ * ownership of those disposables that are added to it as array elements.
  */
 function computedArray(obsArr, mapper) {
     return new ComputedArray(obsArr, mapper);
@@ -258,9 +278,12 @@ exports.computedArray = computedArray;
  * observable will not be adjusted as the array changes, except to keep it valid.
  */
 function makeLiveIndex(owner, obsArr, initialIndex = 0) {
-    return dispose_1.setDisposeOwner(owner, new LiveIndex(obsArr, initialIndex));
+    return (0, dispose_1.setDisposeOwner)(owner, new LiveIndex(obsArr, initialIndex));
 }
 exports.makeLiveIndex = makeLiveIndex;
+/**
+ * An Observable that represents an index into an `ObsArray`, clamped to be in the valid range.
+ */
 class LiveIndex extends observable_1.Observable {
     constructor(_obsArray, initialIndex = 0) {
         super(null);
@@ -269,16 +292,26 @@ class LiveIndex extends observable_1.Observable {
         this.set(initialIndex);
         this._listener = _obsArray.addListener(this._onArrayChange, this);
     }
+    /**
+     * Set the index, clamping it to a valid value.
+     */
     set(index) {
         // Clamp to [0, len) range of the observable array.
         const len = this._obsArray.get().length;
         super.set(len === 0 ? null : Math.max(0, Math.min(len - 1, index || 0)));
     }
-    // Note that this feature comes from a rather obscure need, and it would be better if something
-    // similar were possible without making it an explicit feature.
+    /**
+     * Turn "liveness" on or off. While set to false, the observable will not be adjusted as the
+     * array changes, except to keep it valid.
+     *
+     * @privateRemarks
+     * Note that this feature comes from a rather obscure need, and it would be better if something
+     * similar were possible without making it an explicit feature.
+     */
     setLive(value) {
         this._isLive = value;
     }
+    /** @override */
     dispose() {
         this._listener.dispose();
         super.dispose();

package/dist/cjs/lib/obsArray.js.map

@@ -1 +1 @@
-{"version":3,"file":"obsArray.js","sourceRoot":"","sources":["../../../lib/obsArray.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;;AAEH,uCAA0E;AAE1E,6CAAwD;AACxD,2CAAoD;AAqBpD;;;GAGG;AACH,MAAa,QAAY,SAAQ,2BAAmB;IAApD;;QACU,gBAAW,GAA0B,SAAS,CAAC;IAsDzD,CAAC;IAlDQ,WAAW,CAAC,QAAiC,EAAE,UAAgB;QACpE,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC;IAEM,WAAW,CAAC,KAAsB;QACvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAAE,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;SAAE;QACzE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,OAAO;QACZ,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,EAA4B,EAAE;gBACvD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACjC,IAAI,CAAC,OAAO,EAAE,CAAC;iBAChB;aACF;YACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QACD,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAES,cAAc,CAAC,KAAU,EAAE,MAA0B;QAC7D,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAES,aAAa,CAAC,MAA2B;QACjD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAAE,OAAO;SAAE;QAClC,IAAI,MAAM,EAAE;YACV,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAiC,EAAE;gBAC3D,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACjC,IAAI,CAAC,OAAO,EAAE,CAAC;iBAChB;aACF;SACF;aAAM;YACL,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;YAEvC,4FAA4F;YAC5F,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;YAC9C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,EAA4B,EAAE;gBACvD,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAC5B;aACF;YACD,mEAAmE;YACnE,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;gBAChC,IAAI,CAAC,OAAO,EAAE,CAAC;aAChB;SACF;IACH,CAAC;CACF;AAvDD,4BAuDC;AAED;;;GAGG;AACH,MAAa,eAAmB,SAAQ,QAAW;IAC1C,IAAI,CAAC,GAAG,IAAS;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;QACxE,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,GAAG;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;SAAE;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;QAC/E,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,OAAO,CAAC,GAAG,IAAS;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;SAAE;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;QACpE,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,MAAM,CAAC,KAAa,EAAE,cAAsB,QAAQ,EAAE,GAAG,SAAc;QAC5E,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;QACzB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;QACzE,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAxCD,0CAwCC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAI,QAAa,EAAE;IACzC,OAAO,IAAI,eAAe,CAAI,KAAK,CAAC,CAAC;AACvC,CAAC;AAFD,4BAEC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,GAAwB;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAa,aAAoB,SAAQ,QAAW;IAMlD,YACE,MAA6D,EACrD,OAAgE;QAExE,KAAK,CAAC,EAAE,CAAC,CAAC;QAFF,YAAO,GAAP,OAAO,CAAyD;QAGxE,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9B,qBAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACnD,qBAAS,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAEO,QAAQ,CAAC,MAA2B;QAC1C,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE;YAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACvB;aAAM,IAAI,IAAI,CAAC,WAAW,EAAE;YAC3B,4FAA4F;YAC5F,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SAC7C;aAAM;YACL,6EAA6E;YAC7E,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;IAC/B,CAAC;IAEO,OAAO;QACb,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;IACH,CAAC;IAEO,QAAQ,CAAC,MAA2B;QAC1C,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAO,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAClG,CAAC;IAEO,YAAY,CAAC,MAA2B,EAAE,MAA0B;QAC1E,MAAM,WAAW,GAAQ,MAAM,CAAC,GAAG,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAQ,EAAE,CAAC;QACzB,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YAC/D,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;SACtE;QACD,MAAM,KAAK,GAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;IACxF,CAAC;IAEO,aAAa,CAAC,QAAa,EAAE,QAAa,EAAE,MAA2B;QAC7E,0FAA0F;QAC1F,8FAA8F;QAC9F,uDAAuD;QACvD,IAAI,MAAM,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAC5C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;SAC3B;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,CAAK,kDAAkD;SACjF;IACH,CAAC;CACF;AAvED,sCAuEC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,aAAa,CAC3B,MAA6D,EAC7D,MAA+D;IAE/D,OAAO,IAAI,aAAa,CAAO,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AALD,sCAKC;AAED;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAAI,KAAwC,EAAE,MAAmB,EAC7D,eAAuB,CAAC;IACvD,OAAO,yBAAe,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AACrE,CAAC;AAHD,sCAGC;AAED,MAAa,SAAU,SAAQ,uBAAuB;IAIpD,YAAoB,SAAwB,EAAE,eAAuB,CAAC;QACpE,KAAK,CAAC,IAAI,CAAC,CAAC;QADM,cAAS,GAAT,SAAS,CAAe;QAFpC,YAAO,GAAY,IAAI,CAAC;QAI9B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAEM,GAAG,CAAC,KAAkB;QAC3B,mDAAmD;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;QACxC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,+FAA+F;IAC/F,+DAA+D;IACxD,OAAO,CAAC,KAAc;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAEO,cAAc,CAAI,QAAa,EAAE,QAAa,EAAE,MAA2B;QACjF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CACN,GAAG,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,wDAAwD;YACxD,IAAI,CAAC,OAAO,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAC7G,2EAA2E;gBAC3E,IAAI,CAAC,OAAO,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACxF,GAAG,CAAC,CAAC;IACT,CAAC;CACF;AArCD,8BAqCC"}
+{"version":3,"file":"obsArray.js","sourceRoot":"","sources":["../../../lib/obsArray.ts"],"names":[],"mappings":";;;AAAA,uCAA0E;AAE1E,6CAAwD;AACxD,2CAAoD;AAqBpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,QAAY,SAAQ,2BAAmB;IAApD;;QACU,gBAAW,GAA0B,SAAS,CAAC;IAiEzD,CAAC;IAzDQ,WAAW,CAAC,QAAiC,EAAE,UAAgB;QACpE,OAAO,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,KAAsB;QACvC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAAE,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;SAAE;QACzE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACT,OAAO;QACZ,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,EAA4B,EAAE;gBACvD,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACjC,IAAI,CAAC,OAAO,EAAE,CAAC;iBAChB;aACF;YACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QACD,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAED,gBAAgB;IACN,cAAc,CAAC,KAAU,EAAE,MAA0B;QAC7D,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IACN,aAAa,CAAC,MAA2B;QACjD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YAAE,OAAO;SAAE;QAClC,IAAI,MAAM,EAAE;YACV,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,OAAiC,EAAE;gBAC3D,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBACjC,IAAI,CAAC,OAAO,EAAE,CAAC;iBAChB;aACF;SACF;aAAM;YACL,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC;YAEvC,4FAA4F;YAC5F,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAmB,CAAC;YAC9C,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,EAA4B,EAAE;gBACvD,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;oBAC9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAC5B;aACF;YACD,mEAAmE;YACnE,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE;gBAChC,IAAI,CAAC,OAAO,EAAE,CAAC;aAChB;SACF;IACH,CAAC;CACF;AAlED,4BAkEC;AAED;;;GAGG;AACH,MAAa,eAAmB,SAAQ,QAAW;IACjD,kFAAkF;IAC3E,IAAI,CAAC,GAAG,IAAS;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;QACxE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,+DAA+D;IACxD,GAAG;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;SAAE;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;QAC/E,OAAO,GAAG,CAAC;IACb,CAAC;IAED,wFAAwF;IACjF,OAAO,CAAC,GAAG,IAAS;QACzB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kEAAkE;IAC3D,KAAK;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAAE,OAAO,SAAS,CAAC;SAAE;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAG,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAC,CAAC,CAAC;QACpE,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAa,EAAE,cAAsB,QAAQ,EAAE,GAAG,SAAc;QAC5E,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC;QACzB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;QACzE,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAhDD,0CAgDC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAI,QAAa,EAAE;IACzC,OAAO,IAAI,eAAe,CAAI,KAAK,CAAC,CAAC;AACvC,CAAC;AAFD,4BAEC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,GAAwB;IAC1C,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAa,aAAoB,SAAQ,QAAW;IAMlD,YACE,MAA6D,EACrD,OAAgE;QAExE,KAAK,CAAC,EAAE,CAAC,CAAC;QAFF,YAAO,GAAP,OAAO,CAAyD;QAGxE,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;YAC9B,IAAA,qBAAS,EAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACnD,IAAA,qBAAS,EAAC,MAAM,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5G,CAAC;IAED,gBAAgB;IACT,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAEO,QAAQ,CAAC,MAA2B;QAC1C,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM,EAAE;YAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;YAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACvB;aAAM,IAAI,IAAI,CAAC,WAAW,EAAE;YAC3B,4FAA4F;YAC5F,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SAC7C;aAAM;YACL,6EAA6E;YAC7E,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACvB;QACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;IAC/B,CAAC;IAEO,OAAO;QACb,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;SAC1B;IACH,CAAC;IAEO,QAAQ,CAAC,MAA2B;QAC1C,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAO,EAAE,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAClG,CAAC;IAEO,YAAY,CAAC,MAA2B,EAAE,MAA0B;QAC1E,MAAM,WAAW,GAAQ,MAAM,CAAC,GAAG,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAQ,EAAE,CAAC;QACzB,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;YAC/D,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;SACtE;QACD,MAAM,KAAK,GAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,EAAC,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAC,CAAC,CAAC;IACxF,CAAC;IAEO,aAAa,CAAC,QAAa,EAAE,QAAa,EAAE,MAA2B;QAC7E,0FAA0F;QAC1F,8FAA8F;QAC9F,uDAAuD;QACvD,IAAI,MAAM,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE;YAC5C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;SAC3B;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,CAAK,kDAAkD;SACjF;IACH,CAAC;CACF;AAxED,sCAwEC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,SAAgB,aAAa,CAC3B,MAA6D,EAC7D,MAA+D;IAE/D,OAAO,IAAI,aAAa,CAAO,MAAM,EAAE,MAAM,CAAC,CAAC;AACjD,CAAC;AALD,sCAKC;AAED;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAAI,KAAwC,EAAE,MAAmB,EAC7D,eAAuB,CAAC;IACvD,OAAO,IAAA,yBAAe,EAAC,KAAK,EAAE,IAAI,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;AACrE,CAAC;AAHD,sCAGC;AAED;;GAEG;AACH,MAAa,SAAU,SAAQ,uBAAuB;IAIpD,YAAoB,SAAwB,EAAE,eAAuB,CAAC;QACpE,KAAK,CAAC,IAAI,CAAC,CAAC;QADM,cAAS,GAAT,SAAS,CAAe;QAFpC,YAAO,GAAY,IAAI,CAAC;QAI9B,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,KAAkB;QAC3B,mDAAmD;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;QACxC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CAAC,KAAc;QAC3B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,OAAO;QACZ,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC;IAEO,cAAc,CAAI,QAAa,EAAE,QAAa,EAAE,MAA2B;QACjF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CACN,GAAG,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,wDAAwD;YACxD,IAAI,CAAC,OAAO,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBAC7G,2EAA2E;gBAC3E,IAAI,CAAC,OAAO,IAAI,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACxF,GAAG,CAAC,CAAC;IACT,CAAC;CACF;AA/CD,8BA+CC"}

package/dist/cjs/lib/observable.d.ts

@@ -24,23 +24,23 @@ import { DepItem } from './_computed_queue';
 import { IDisposable, IDisposableOwnerT } from './dispose';
 import { Listener } from './emit';
 export { bundleChanges } from './_computed_queue';
+/**
+ * Base class for several variants of observable values.
+ */
 export declare class BaseObservable<T> {
     private _onChange;
     private _value;
-    /**
-     * Internal constructor for an Observable. You should use observable() function instead.
-     */
     constructor(value: T);
     /**
      * Returns the value of the observable. It is fast and does not create a subscription.
      * (It is similar to knockout's peek()).
-     * @returns {Object} The current value of the observable.
+     * @returns The current value of the observable.
      */
     get(): T;
     /**
      * Sets the value of the observable. If the value differs from the previously set one, then
      * listeners to this observable will get called with (newValue, oldValue) as arguments.
-     * @param {Object} value: The new value to set.
+     * @param value - The new value to set.
      */
     set(value: T): void;
     /**
@@ -49,9 +49,9 @@ export declare class BaseObservable<T> {
     setAndTrigger(value: T): void;
     /**
      * Adds a callback to listen to changes in the observable.
-     * @param {Function} callback: Function, called on changes with (newValue, oldValue) arguments.
-     * @param {Object} optContext: Context for the function.
-     * @returns {Listener} Listener object. Its dispose() method removes the callback.
+     * @param callback - Function, called on changes with (newValue, oldValue) arguments.
+     * @param optContext - Context for the function.
+     * @returns Listener object. Its dispose() method removes the callback.
      */
     addListener(callback: (val: T, prev: T) => void, optContext?: object): Listener;
     /**
@@ -61,7 +61,7 @@ export declare class BaseObservable<T> {
     /**
      * Sets a single callback to be called when a listener is added or removed. It overwrites any
      * previously-set such callback.
-     * @param {Function} changeCB(hasListeners): Function to call after a listener is added or
+     * @param changeCB - Function to call after a listener is added or
      *    removed. It's called with a boolean indicating whether this observable has any listeners.
      *    Pass in `null` to unset the callback. Note that it can be called multiple times in a row
      *    with hasListeners `true`.
@@ -70,6 +70,7 @@ export declare class BaseObservable<T> {
     /**
      * Used by subscriptions to keep track of dependencies. An observable that has dependnecies,
      * such as a computed observable, would override this method.
+     * @internal
      */
     _getDepItem(): DepItem | null;
     /**
@@ -80,14 +81,20 @@ export declare class BaseObservable<T> {
      * Returns whether this observable is disposed.
      */
     isDisposed(): boolean;
+    /** @internal */
     protected _disposeOwned(arg?: any): void;
     /**
      * Allow derived classes to emit change events with an additional third argument describing the
      * change. It always emits the event without checking for value equality.
+     * @internal
      */
     protected _setWithArg(value: T, arg: any): void;
 }
+/**
+ * An Observable holds a value and allows subscribing to changes.
+ */
 export declare class Observable<T> extends BaseObservable<T> implements IDisposableOwnerT<T & IDisposable> {
+    /** @internal */
     static holder<T>(value: T & IDisposable): Observable<T>;
     /**
      * Creates a new Observable with the given initial value, and owned by owner.
@@ -104,25 +111,28 @@ export declare class Observable<T> extends BaseObservable<T> implements IDisposa
      * will dispose the owned value when it's set to another value, or when it itself is disposed.
      */
     autoDispose(value: T & IDisposable): T & IDisposable;
+    /** @internal */
     protected _disposeOwned(): void;
 }
 /**
  * Creates a new Observable with the initial value of optValue if given or undefined if omitted.
- * @param {Object} optValue: The initial value to set.
- * @returns {Observable} The newly created observable.
+ * @param optValue - The initial value to set.
+ * @returns The newly created observable.
  */
 export declare function observable<T>(value: T): Observable<T>;
 /**
  * Creates a new Observable with an initial disposable value owned by this observable, e.g.
- *
+ * ```
  *    const obs = obsHolder<D>(D.create(null, ...args));
+ * ```
  *
- * This is needed because using simply observable<D>(value) would not cause the observable to take
+ * This is needed because using simply `observable<D>(value)` would not cause the observable to take
  * ownership of value (i.e. to dispose it later). This function is a less hacky equivalent to:
- *
+ * ```
  *    const obs = observable<D>(null as any);
  *    D.create(obs, ...args);
+ * ```
  *
- * To allow nulls, use observable<D|null>(null); then the obsHolder() constructor is not needed.
+ * To allow nulls, use `observable<D|null>(null)`; then the obsHolder() constructor is not needed.
  */
 export declare function obsHolder<T>(value: T & IDisposable): Observable<T>;

package/dist/cjs/lib/observable.js

@@ -22,15 +22,17 @@
  * dependency is created, and which observables the dependency connects.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.obsHolder = exports.observable = exports.Observable = exports.BaseObservable = exports.bundleChanges = void 0;
 const _computed_queue_1 = require("./_computed_queue");
 const dispose_1 = require("./dispose");
 const emit_1 = require("./emit");
 var _computed_queue_2 = require("./_computed_queue");
-exports.bundleChanges = _computed_queue_2.bundleChanges;
+Object.defineProperty(exports, "bundleChanges", { enumerable: true, get: function () { return _computed_queue_2.bundleChanges; } });
+/**
+ * Base class for several variants of observable values.
+ */
 class BaseObservable {
-    /**
-     * Internal constructor for an Observable. You should use observable() function instead.
-     */
+    // Internal constructor for an Observable. You should use observable() function instead.
     constructor(value) {
         this._onChange = new emit_1.Emitter();
         this._value = value;
@@ -38,13 +40,13 @@ class BaseObservable {
     /**
      * Returns the value of the observable. It is fast and does not create a subscription.
      * (It is similar to knockout's peek()).
-     * @returns {Object} The current value of the observable.
+     * @returns The current value of the observable.
      */
     get() { return this._value; }
     /**
      * Sets the value of the observable. If the value differs from the previously set one, then
      * listeners to this observable will get called with (newValue, oldValue) as arguments.
-     * @param {Object} value: The new value to set.
+     * @param value - The new value to set.
      */
     set(value) {
         if (value !== this._value) {
@@ -59,13 +61,13 @@ class BaseObservable {
         this._value = value;
         this._onChange.emit(value, prev);
         this._disposeOwned();
-        _computed_queue_1.compute();
+        (0, _computed_queue_1.compute)();
     }
     /**
      * Adds a callback to listen to changes in the observable.
-     * @param {Function} callback: Function, called on changes with (newValue, oldValue) arguments.
-     * @param {Object} optContext: Context for the function.
-     * @returns {Listener} Listener object. Its dispose() method removes the callback.
+     * @param callback - Function, called on changes with (newValue, oldValue) arguments.
+     * @param optContext - Context for the function.
+     * @returns Listener object. Its dispose() method removes the callback.
      */
     addListener(callback, optContext) {
         return this._onChange.addListener(callback, optContext);
@@ -79,7 +81,7 @@ class BaseObservable {
     /**
      * Sets a single callback to be called when a listener is added or removed. It overwrites any
      * previously-set such callback.
-     * @param {Function} changeCB(hasListeners): Function to call after a listener is added or
+     * @param changeCB - Function to call after a listener is added or
      *    removed. It's called with a boolean indicating whether this observable has any listeners.
      *    Pass in `null` to unset the callback. Note that it can be called multiple times in a row
      *    with hasListeners `true`.
@@ -90,6 +92,7 @@ class BaseObservable {
     /**
      * Used by subscriptions to keep track of dependencies. An observable that has dependnecies,
      * such as a computed observable, would override this method.
+     * @internal
      */
     _getDepItem() {
         return null;
@@ -108,25 +111,31 @@ class BaseObservable {
     isDisposed() {
         return this._onChange.isDisposed();
     }
+    /** @internal */
     _disposeOwned(arg) { }
     /**
      * Allow derived classes to emit change events with an additional third argument describing the
      * change. It always emits the event without checking for value equality.
+     * @internal
      */
     _setWithArg(value, arg) {
         const prev = this._value;
         this._value = value;
         this._onChange.emit(value, prev, arg);
         this._disposeOwned(arg);
-        _computed_queue_1.compute();
+        (0, _computed_queue_1.compute)();
     }
 }
 exports.BaseObservable = BaseObservable;
+/**
+ * An Observable holds a value and allows subscribing to changes.
+ */
 class Observable extends BaseObservable {
     constructor() {
         super(...arguments);
         this._owned = undefined;
     }
+    /** @internal */
     // See module-level holder() function below for documentation.
     static holder(value) {
         const obs = new Observable(value);
@@ -137,7 +146,7 @@ class Observable extends BaseObservable {
      * Creates a new Observable with the given initial value, and owned by owner.
      */
     static create(owner, value) {
-        return dispose_1.setDisposeOwner(owner, new Observable(value));
+        return (0, dispose_1.setDisposeOwner)(owner, new Observable(value));
     }
     /**
      * The use an observable for a disposable object, use it a DisposableOwner:
@@ -153,6 +162,7 @@ class Observable extends BaseObservable {
         this._owned = value;
         return value;
     }
+    /** @internal */
     _disposeOwned() {
         if (this._owned) {
             this._owned.dispose();
@@ -163,8 +173,8 @@ class Observable extends BaseObservable {
 exports.Observable = Observable;
 /**
  * Creates a new Observable with the initial value of optValue if given or undefined if omitted.
- * @param {Object} optValue: The initial value to set.
- * @returns {Observable} The newly created observable.
+ * @param optValue - The initial value to set.
+ * @returns The newly created observable.
  */
 function observable(value) {
     return new Observable(value);
@@ -172,16 +182,18 @@ function observable(value) {
 exports.observable = observable;
 /**
  * Creates a new Observable with an initial disposable value owned by this observable, e.g.
- *
+ * ```
  *    const obs = obsHolder<D>(D.create(null, ...args));
+ * ```
  *
- * This is needed because using simply observable<D>(value) would not cause the observable to take
+ * This is needed because using simply `observable<D>(value)` would not cause the observable to take
  * ownership of value (i.e. to dispose it later). This function is a less hacky equivalent to:
- *
+ * ```
  *    const obs = observable<D>(null as any);
  *    D.create(obs, ...args);
+ * ```
  *
- * To allow nulls, use observable<D|null>(null); then the obsHolder() constructor is not needed.
+ * To allow nulls, use `observable<D|null>(null)`; then the obsHolder() constructor is not needed.
  */
 function obsHolder(value) {
     return Observable.holder(value);

package/dist/cjs/lib/observable.js.map

@@ -1 +1 @@
-{"version":3,"file":"observable.js","sourceRoot":"","sources":["../../../lib/observable.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAEH,uDAAmD;AACnD,uCAA0E;AAC1E,iCAAyC;AAEzC,qDAAgD;AAAxC,0CAAA,aAAa,CAAA;AAErB,MAAa,cAAc;IAIzB;;OAEG;IACH,YAAY,KAAQ;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,cAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,GAAG,KAAQ,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC;;;;OAIG;IACI,GAAG,CAAC,KAAQ;QACjB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,EAAE;YACzB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAC3B;IACH,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,KAAQ;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,yBAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,QAAmC,EAAE,UAAmB;QACzE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAC,QAAyC,EAAE,UAAgB;QACpF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,MAAc,GAAG,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAES,aAAa,CAAC,GAAS,IAAe,CAAC;IAEjD;;;OAGG;IACO,WAAW,CAAC,KAAQ,EAAE,GAAQ;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxB,yBAAO,EAAE,CAAC;IACZ,CAAC;CACF;AA3GD,wCA2GC;AAED,MAAa,UAAc,SAAQ,cAAiB;IAApD;;QAeU,WAAM,GAAqB,SAAS,CAAC;IAuB/C,CAAC;IArCC,8DAA8D;IACvD,MAAM,CAAC,MAAM,CAAI,KAAsB;QAC5C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC;QACnB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAI,KAA4C,EAAE,KAAQ;QAC5E,OAAO,yBAAe,CAAC,KAAK,EAAE,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IAID;;;;;;;;OAQG;IACI,WAAW,CAAC,KAAsB;QACvC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAES,aAAa;QACrB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;CACF;AAtCD,gCAsCC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAI,KAAQ;IACpC,OAAO,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC;AAClC,CAAC;AAFD,gCAEC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,SAAS,CAAI,KAAsB;IACjD,OAAO,UAAU,CAAC,MAAM,CAAI,KAAK,CAAC,CAAC;AACrC,CAAC;AAFD,8BAEC"}
+{"version":3,"file":"observable.js","sourceRoot":"","sources":["../../../lib/observable.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAEH,uDAAmD;AACnD,uCAA0E;AAC1E,iCAAyC;AAEzC,qDAAgD;AAAxC,gHAAA,aAAa,OAAA;AAErB;;GAEG;AACH,MAAa,cAAc;IAIzB,wFAAwF;IACxF,YAAY,KAAQ;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,cAAO,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,GAAG,KAAQ,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC;;;;OAIG;IACI,GAAG,CAAC,KAAQ;QACjB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,EAAE;YACzB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SAC3B;IACH,CAAC;IAED;;OAEG;IACI,aAAa,CAAC,KAAQ;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAA,yBAAO,GAAE,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,QAAmC,EAAE,UAAmB;QACzE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAC,QAAyC,EAAE,UAAgB;QACpF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,MAAc,GAAG,SAAS,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;IACrC,CAAC;IAED,gBAAgB;IACN,aAAa,CAAC,GAAS,IAAe,CAAC;IAEjD;;;;OAIG;IACO,WAAW,CAAC,KAAQ,EAAE,GAAQ;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACxB,IAAA,yBAAO,GAAE,CAAC;IACZ,CAAC;CACF;AA5GD,wCA4GC;AAED;;GAEG;AACH,MAAa,UAAc,SAAQ,cAAiB;IAApD;;QAgBU,WAAM,GAAqB,SAAS,CAAC;IAwB/C,CAAC;IAvCC,gBAAgB;IAChB,8DAA8D;IACvD,MAAM,CAAC,MAAM,CAAI,KAAsB;QAC5C,MAAM,GAAG,GAAG,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC;QACrC,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC;QACnB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAI,KAA4C,EAAE,KAAQ;QAC5E,OAAO,IAAA,yBAAe,EAAC,KAAK,EAAE,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IAID;;;;;;;;OAQG;IACI,WAAW,CAAC,KAAsB;QACvC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACN,aAAa;QACrB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACtB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;SACzB;IACH,CAAC;CACF;AAxCD,gCAwCC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAI,KAAQ;IACpC,OAAO,IAAI,UAAU,CAAI,KAAK,CAAC,CAAC;AAClC,CAAC;AAFD,gCAEC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,SAAS,CAAI,KAAsB;IACjD,OAAO,UAAU,CAAC,MAAM,CAAI,KAAK,CAAC,CAAC;AACrC,CAAC;AAFD,8BAEC"}

package/dist/cjs/lib/pureComputed.d.ts

@@ -1,33 +1,32 @@
+import { DepItem } from './_computed_queue';
+import { Observable } from './observable';
+import { ISubscribable, UseCB } from './subscribe';
 /**
- * pureComputed.js implements a variant of computed() suitable for use with a pure read function
- * (free of side-effects). A pureComputed is only subscribed to its dependencies when something is
+ * `PureComputed` is a variant of `Computed` suitable for use with a pure read function
+ * (free of side-effects). A `PureComputed` is only subscribed to its dependencies when something is
  * subscribed to it. At other times, it is not subscribed to anything, and calls to `get()` will
- * recompute its value each time by calling its read() function.
+ * recompute its value each time by calling its `read()` function.
  *
- * Its syntax and usage are otherwise exactly as for a computed.
+ * Its syntax and usage are otherwise exactly as for a `Computed`.
  *
- * In addition to being cheaper when unused, a pureComputed() also avoids leaking memory when
+ * In addition to being cheaper when unused, a `PureComputed` also avoids leaking memory when
  * unused (since it's not registered with dependencies), so it is not necessary to dispose it.
  */
-import { DepItem } from './_computed_queue';
-import { Observable } from './observable';
-import { ISubscribable, UseCB } from './subscribe';
 export declare class PureComputed<T> extends Observable<T> {
     private _callback;
     private _write;
     private _sub;
     private readonly _dependencies;
     private _inCall;
-    /**
-     * Internal constructor for a PureComputed. You should use pureComputed() function instead.
-     */
     constructor(callback: (use: UseCB, ...args: any[]) => T, dependencies: ReadonlyArray<ISubscribable>);
+    /** @internal */
     _getDepItem(): DepItem;
+    /** @override */
     get(): T;
     /**
      * "Sets" the value of the pure computed by calling the write() callback if one was provided in
      * the constructor. Throws an error if there was no such callback (not a "writable" computed).
-     * @param {Object} value: The value to pass to the write() callback.
+     * @param value - The value to pass to the write() callback.
      */
     set(value: T): void;
     /**
@@ -44,9 +43,7 @@ export declare class PureComputed<T> extends Observable<T> {
     private _read;
 }
 /**
- * This is the type-checking interface for pureComputed(), which allows TypeScript to do helpful
- * type-checking when using it. We can only support a fixed number of argumnets (explicit
- * dependencies), but 5 should almost always be enough.
+ * Creates and returns a new PureComputed. The interface is identical to that of a Computed.
  */
 export declare function pureComputed<T>(cb: (use: UseCB) => T): PureComputed<T>;
 export declare function pureComputed<A, T>(a: Observable<A>, cb: (use: UseCB, a: A) => T): PureComputed<T>;