grainjs 1.0.1 → 1.1.0

package/dist/cjs/lib/emit.js

@@ -1,43 +1,10 @@
 "use strict";
-/**
- * emit.js implements an Emitter class which emits events to a list of listeners. Listeners are
- * simply functions to call, and "emitting an event" just calls those functions.
- *
- * This is similar to Backbone events, with more focus on efficiency. Both inserting and removing
- * listeners is constant time.
- *
- * To create an emitter:
- *    let emitter = new Emitter();
- *
- * To add a listener:
- *    let listener = fooEmitter.addListener(callback);
- * To remove a listener:
- *    listener.dispose();
- *
- * The only way to remove a listener is to dispose the Listener object returned by addListener().
- * You can often use autoDispose to do this automatically when subscribing in a constructor:
- *    this.autoDispose(fooEmitter.addListener(this.onFoo, this));
- *
- * To emit an event, call emit() with any number of arguments:
- *    emitter.emit("hello", "world");
- */
 Object.defineProperty(exports, "__esModule", { value: true });
-// Note about a possible alternative implementation.
-//
-// We could implement the same interface using an array of listeners. Certain issues apply, in
-// particular with removing listeners from inside emit(), and in ensuring that removals are
-// constant time on average. Such an implementation was attempted and timed. The result is that
-// compared to the linked-list implementation here, add/remove combination could be made nearly
-// twice faster (on average), while emit and add/remove/emit are consistently slightly slower.
-//
-// The implementation here was chosen based on those timings, and as the simpler one. For example,
-// on one setup (macbook, node4, 5-listener queue), add+remove take 0.1us, while add+remove+emit
-// take 3.82us. (In array-based implementation with same set up, add+remove is 0.06us, while
-// add+remove+emit is 4.80us.)
-// The private property name to hold next/prev pointers.
+exports.Listener = exports.Emitter = exports.LLink = void 0;
 function _noop() { }
 /**
  * This is an implementation of a doubly-linked list, with just the minimal functionality we need.
+ * @internal
  */
 class LLink {
     constructor() {
@@ -66,7 +33,7 @@ class LLink {
         node._prev = node._next = null;
     }
     _disposeList() {
-        let node = this;
+        let node = this; // eslint-disable-line @typescript-eslint/no-this-alias
         let next = node._next;
         while (next !== null) {
             node._next = node._prev = null;
@@ -76,20 +43,65 @@ class LLink {
     }
 }
 exports.LLink = LLink;
+/**
+ * An `Emitter` emits events to a list of listeners. Listeners are
+ * simply functions to call, and "emitting an event" just calls those functions.
+ *
+ * This is similar to Backbone events, with more focus on efficiency. Both inserting and removing
+ * listeners is constant time.
+ *
+ * To create an emitter:
+ * ```ts
+ * const emitter = new Emitter();
+ * ```
+ *
+ * To add a listener:
+ * ```ts
+ * const listener = fooEmitter.addListener(callback);
+ * ```
+ *
+ * To remove a listener:
+ * ```ts
+ * listener.dispose();
+ * ```
+ *
+ * The only way to remove a listener is to dispose the `Listener` object returned by `addListener()`.
+ * You can often use autoDispose to do this automatically when subscribing in a constructor:
+ * ```ts
+ * this.autoDispose(fooEmitter.addListener(this.onFoo, this));
+ * ```
+ *
+ * To emit an event, call `emit()` with any number of arguments:
+ * ```ts
+ * emitter.emit("hello", "world");
+ * ```
+ *
+ * @privateRemarks
+ *
+ * Note about a possible alternative implementation.
+ *
+ * We could implement the same interface using an array of listeners. Certain issues apply, in
+ * particular with removing listeners from inside emit(), and in ensuring that removals are
+ * constant time on average. Such an implementation was attempted and timed. The result is that
+ * compared to the linked-list implementation here, add/remove combination could be made nearly
+ * twice faster (on average), while emit and add/remove/emit are consistently slightly slower.
+ *
+ * The implementation here was chosen based on those timings, and as the simpler one. For example,
+ * on one setup (macbook, node4, 5-listener queue), add+remove take 0.1us, while add+remove+emit
+ * take 3.82us. (In array-based implementation with same set up, add+remove is 0.06us, while
+ * add+remove+emit is 4.80us.)
+ */
 class Emitter extends LLink {
-    /**
-     * Constructs an Emitter object.
-     */
     constructor() {
-        super();
+        super(...arguments);
         this._changeCB = _noop;
         this._changeCBContext = undefined;
     }
     /**
      * Adds a listening callback to the list of functions to call on emit().
-     * @param {Function} callback: Function to call.
-     * @param {Object} optContext: Context for the function.
-     * @returns {Listener} Listener object. Its dispose() method removes the callback from the list.
+     * @param callback - Function to call.
+     * @param optContext - Context for the function.
+     * @returns Listener object. Its dispose() method removes the callback from the list.
      */
     addListener(callback, optContext) {
         return new Listener(this, callback, optContext);
@@ -102,7 +114,7 @@ class Emitter extends LLink {
     }
     /**
      * Sets the single callback that would get called when a listener is added or removed.
-     * @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 Emitter has any listeners.
      *    Pass in `null` to unset the callback. Note that it can be called multiple times in a row
      *    with hasListeners `true`.
@@ -113,6 +125,7 @@ class Emitter extends LLink {
     }
     /**
      * Helper used by Listener class, but not intended for public usage.
+     * @internal
      */
     _triggerChangeCB() {
         this._changeCB.call(this._changeCBContext, this.hasListeners());
@@ -135,10 +148,18 @@ class Emitter extends LLink {
 }
 exports.Emitter = Emitter;
 /**
- * Listener object wraps a callback added to an Emitter, allowing for O(1) removal when the
- * listener is disposed.
+ * The `Listener` object wraps a callback added to an Emitter, allowing for O(1) removal when the
+ * listener is disposed. It implements `IDisposable`.
  */
 class Listener extends LLink {
+    /** @internal */
+    static callAll(begin, end, args) {
+        while (begin !== end) {
+            const lis = begin;
+            lis.callback.call(lis.context, ...args);
+            begin = lis._next;
+        }
+    }
     constructor(emitter, callback, context) {
         super();
         this.emitter = emitter;
@@ -147,13 +168,7 @@ class Listener extends LLink {
         this._insertBefore(emitter, this);
         emitter._triggerChangeCB();
     }
-    static callAll(begin, end, args) {
-        while (begin !== end) {
-            const lis = begin;
-            lis.callback.call(lis.context, ...args);
-            begin = lis._next;
-        }
-    }
+    /** @internal */
     dispose() {
         if (this.isDisposed()) {
             return;

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

@@ -1 +1 @@
-{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../../lib/emit.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;AAEH,oDAAoD;AACpD,EAAE;AACF,8FAA8F;AAC9F,2FAA2F;AAC3F,+FAA+F;AAC/F,+FAA+F;AAC/F,8FAA8F;AAC9F,EAAE;AACF,kGAAkG;AAClG,gGAAgG;AAChG,4FAA4F;AAC5F,8BAA8B;AAE9B,wDAAwD;AAExD,SAAS,KAAK,KAAe,CAAC;AAK9B;;GAEG;AACH,MAAa,KAAK;IAIhB;QAHU,UAAK,GAAe,IAAI,CAAC;QACzB,UAAK,GAAe,IAAI,CAAC;QAGjC,2FAA2F;QAC3F,2DAA2D;QAC3D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAEM,UAAU;QACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;IACrB,CAAC;IAES,aAAa,CAAC,IAAW,EAAE,IAAW;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAES,WAAW,CAAC,IAAW;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YAC9B,IAAI,CAAC,KAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAChC;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACjC,CAAC;IAES,YAAY;QACpB,IAAI,IAAI,GAAU,IAAI,CAAC;QACvB,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACtB,OAAO,IAAI,KAAK,IAAI,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAC/B,IAAI,GAAG,IAAI,CAAC;YACZ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;SACnB;IACH,CAAC;CACF;AAxCD,sBAwCC;AAED,MAAa,OAAQ,SAAQ,KAAK;IAIhC;;OAEG;IACH;QAAgB,KAAK,EAAE,CAAC;QANhB,cAAS,GAAa,KAAK,CAAC;QAC5B,qBAAgB,GAAQ,SAAS,CAAC;IAKjB,CAAC;IAE1B;;;;;OAKG;IACI,WAAW,CAAI,QAAuB,EAAE,UAAc;QAC3D,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,GAAG,IAAW;QACxB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,QAAkB,EAAE,UAAgB;QACrD,IAAI,CAAC,SAAS,GAAG,QAAQ,IAAI,KAAK,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;IACpC,CAAC;CACF;AA7DD,0BA6DC;AAED;;;GAGG;AACH,MAAa,QAAS,SAAQ,KAAK;IASjC,YAAoB,OAAgB,EAChB,QAAyB,EACzB,OAAa;QAC/B,KAAK,EAAE,CAAC;QAHU,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,YAAO,GAAP,OAAO,CAAM;QAE/B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAC7B,CAAC;IAdM,MAAM,CAAC,OAAO,CAAC,KAAY,EAAE,GAAU,EAAE,IAAW;QACzD,OAAO,KAAK,KAAK,GAAG,EAAE;YACpB,MAAM,GAAG,GAAG,KAAiB,CAAC;YAC9B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;YACxC,KAAK,GAAG,GAAG,CAAC,KAAM,CAAC;SACpB;IACH,CAAC;IAUM,OAAO;QACZ,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YAAE,OAAO;SAAE;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAClC,CAAC;CACF;AAtBD,4BAsBC"}
+{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../../lib/emit.ts"],"names":[],"mappings":";;;AAAA,SAAS,KAAK,KAAe,CAAC;AAU9B;;;GAGG;AACH,MAAa,KAAK;IAIhB;QAHU,UAAK,GAAe,IAAI,CAAC;QACzB,UAAK,GAAe,IAAI,CAAC;QAGjC,2FAA2F;QAC3F,2DAA2D;QAC3D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAEM,UAAU;QACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;IACrB,CAAC;IAES,aAAa,CAAC,IAAW,EAAE,IAAW;QAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAES,WAAW,CAAC,IAAW;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YAC9B,IAAI,CAAC,KAAM,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SAChC;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACjC,CAAC;IAES,YAAY;QACpB,IAAI,IAAI,GAAU,IAAI,CAAC,CAAK,uDAAuD;QACnF,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QACtB,OAAO,IAAI,KAAK,IAAI,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAC/B,IAAI,GAAG,IAAI,CAAC;YACZ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;SACnB;IACH,CAAC;CACF;AAxCD,sBAwCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAa,OAAQ,SAAQ,KAAK;IAAlC;;QACU,cAAS,GAAa,KAAK,CAAC;QAC5B,qBAAgB,GAAQ,SAAS,CAAC;IAuD5C,CAAC;IArDC;;;;;OAKG;IACI,WAAW,CAAI,QAAuB,EAAE,UAAc;QAC3D,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,GAAG,IAAW;QACxB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,QAAkB,EAAE,UAAgB;QACrD,IAAI,CAAC,SAAS,GAAG,QAAQ,IAAI,KAAK,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;IACrC,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACrB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,OAAO;QACZ,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;IACpC,CAAC;CACF;AAzDD,0BAyDC;AAED;;;GAGG;AACH,MAAa,QAAS,SAAQ,KAAK;IACjC,gBAAgB;IACT,MAAM,CAAC,OAAO,CAAC,KAAY,EAAE,GAAU,EAAE,IAAW;QACzD,OAAO,KAAK,KAAK,GAAG,EAAE;YACpB,MAAM,GAAG,GAAG,KAAiB,CAAC;YAC9B,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;YACxC,KAAK,GAAG,GAAG,CAAC,KAAM,CAAC;SACpB;IACH,CAAC;IAED,YAAoB,OAAgB,EAChB,QAAyB,EACzB,OAAa;QAC/B,KAAK,EAAE,CAAC;QAHU,YAAO,GAAP,OAAO,CAAS;QAChB,aAAQ,GAAR,QAAQ,CAAiB;QACzB,YAAO,GAAP,OAAO,CAAM;QAE/B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAC7B,CAAC;IAED,gBAAgB;IACT,OAAO;QACZ,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YAAE,OAAO;SAAE;QAClC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAClC,CAAC;CACF;AAxBD,4BAwBC"}

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

@@ -32,7 +32,7 @@ export interface IKnockoutReadObservable<T> {
     subscribe(callback: (newValue: T) => void, target?: any, event?: "change"): any;
     getSubscriptionsCount(): number;
 }
-export declare type InferKoType<KObs extends IKnockoutReadObservable<any>> = KObs extends {
+export type InferKoType<KObs extends IKnockoutReadObservable<any>> = KObs extends {
     peek(): infer T;
 } ? T : never;
 /**
@@ -44,18 +44,21 @@ export declare type InferKoType<KObs extends IKnockoutReadObservable<any>> = KOb
  */
 export declare function fromKo<KObs extends IKnockoutObservable<any>>(koObs: KObs): Observable<InferKoType<KObs>>;
 /**
- * An Observable that wraps a Knockout observable, created via fromKo(). It keeps minimal overhead
+ * An Observable that wraps a Knockout observable, created via `fromKo()`. It keeps minimal overhead
  * when unused by only subscribing to the wrapped observable while it itself has subscriptions.
  *
- * This way, when unused, the only reference is from the wrapper to the wrapped object. KoWrapObs
+ * This way, when unused, the only reference is from the wrapper to the wrapped object. `KoWrapObs`
  * should not be disposed; its lifetime is tied to that of the wrapped object.
  */
 export declare class KoWrapObs<T> extends Observable<T> {
     private _koObs;
     private _koSub;
     constructor(_koObs: IKnockoutObservable<T>);
+    /** @override */
     get(): T;
+    /** @override */
     set(value: T): void;
+    /** @override */
     dispose(): void;
 }
 export interface IKnockoutModule {

package/dist/cjs/lib/kowrap.js

@@ -24,6 +24,7 @@
  * the returned wrapper should not be disposed; it's tied to the lifetime of the wrapped object.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupKoDisposal = exports.toKo = exports.KoWrapObs = exports.fromKo = void 0;
 const domDispose_1 = require("./domDispose");
 const observable_1 = require("./observable");
 const fromKoWrappers = new WeakMap();
@@ -40,10 +41,10 @@ function fromKo(koObs) {
 }
 exports.fromKo = fromKo;
 /**
- * An Observable that wraps a Knockout observable, created via fromKo(). It keeps minimal overhead
+ * An Observable that wraps a Knockout observable, created via `fromKo()`. It keeps minimal overhead
  * when unused by only subscribing to the wrapped observable while it itself has subscriptions.
  *
- * This way, when unused, the only reference is from the wrapper to the wrapped object. KoWrapObs
+ * This way, when unused, the only reference is from the wrapper to the wrapped object. `KoWrapObs`
  * should not be disposed; its lifetime is tied to that of the wrapped object.
  */
 class KoWrapObs extends observable_1.Observable {
@@ -64,8 +65,11 @@ class KoWrapObs extends observable_1.Observable {
             }
         });
     }
+    /** @override */
     get() { return this._koObs.peek(); }
-    set(value) { observable_1.bundleChanges(() => this._koObs(value)); }
+    /** @override */
+    set(value) { (0, observable_1.bundleChanges)(() => this._koObs(value)); }
+    /** @override */
     dispose() { throw new Error("KoWrapObs should not be disposed"); }
 }
 exports.KoWrapObs = KoWrapObs;

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

@@ -1 +1 @@
-{"version":3,"file":"kowrap.js","sourceRoot":"","sources":["../../../lib/kowrap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;AAEH,6CAA6C;AAC7C,6CAAuD;AA0BvD,MAAM,cAAc,GAAuD,IAAI,OAAO,EAAE,CAAC;AACzF,MAAM,YAAY,GAAuD,IAAI,OAAO,EAAE,CAAC;AAEvF;;;;;;GAMG;AACH,SAAgB,MAAM,CAAwC,KAAW;IACvE,OAAO,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;AAClG,CAAC;AAFD,wBAEC;AAED;;;;;;GAMG;AACH,MAAa,SAAa,SAAQ,uBAAa;IAG7C,YAAoB,MAA8B;QAChD,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QADH,WAAM,GAAN,MAAM,CAAwB;QAF1C,WAAM,GAAQ,IAAI,CAAC;QAIzB,IAAI,CAAC,mBAAmB,CAAC,CAAC,YAAY,EAAE,EAAE;YACxC,IAAI,CAAC,YAAY,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;aACpB;iBAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACvB,0FAA0F;gBAC1F,wDAAwD;gBACvD,IAAY,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;aACvE;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACM,GAAG,KAAQ,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACvC,GAAG,CAAC,KAAQ,IAAU,0BAAa,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,OAAO,KAAW,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC,CAAC,CAAC;CAChF;AApBD,8BAoBC;AAOD;;GAEG;AACH,SAAgB,IAAI,CAAI,QAAyB,EAAE,QAAuB;IACxE,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,SAAS,EAAE;QACb,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IACrD,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACrC,QAAQ,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,OAAO,QAAQ,CAAC;AAClB,CAAC;AATD,oBASC;AAED,wEAAwE;AACxE,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B;;;;;;;;;;;;GAYG;AACH,SAAgB,eAAe,CAAC,EAAmB;IACjD,yFAAyF;IACzF,IAAI,iBAAiB,EAAE;QAAE,OAAO;KAAE;IAClC,iBAAiB,GAAG,IAAI,CAAC;IAEzB,MAAM,iBAAiB,GAAI,EAAU,CAAC,KAAK,CAAC,eAAe,CAAC;IAE5D,8FAA8F;IAC9F,kFAAkF;IAClF,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC;IAEpE,yFAAyF;IACzF,MAAM,yBAAyB,GAAG,4BAAe,CAAC,gBAAgB,CAAC;IAEnE,8FAA8F;IAC9F,2DAA2D;IAC3D,SAAS,sBAAsB,CAAC,IAAU;QACxC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC9B,4BAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,2FAA2F;IAC3F,4FAA4F;IAC5F,kBAAkB;IAClB,SAAS,wBAAwB,CAAC,IAAU;QAC1C,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAEhC,6FAA6F;QAC7F,0CAA0C;QAC1C,iBAAiB,CAAC,iBAAiB,GAAG,uBAAuB,CAAC;QAC9D,IAAI;YACF,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACpB;gBAAS;YACR,iBAAiB,CAAC,iBAAiB,GAAG,sBAAsB,CAAC;SAC9D;IACH,CAAC;IAED,4EAA4E;IAC5E,iBAAiB,CAAC,iBAAiB,GAAG,sBAAsB,CAAC;IAC7D,4BAAe,CAAC,gBAAgB,GAAG,wBAAwB,CAAC;AAC9D,CAAC;AAxCD,0CAwCC"}
+{"version":3,"file":"kowrap.js","sourceRoot":"","sources":["../../../lib/kowrap.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;;;AAEH,6CAA6C;AAC7C,6CAAuD;AA0BvD,MAAM,cAAc,GAAuD,IAAI,OAAO,EAAE,CAAC;AACzF,MAAM,YAAY,GAAuD,IAAI,OAAO,EAAE,CAAC;AAEvF;;;;;;GAMG;AACH,SAAgB,MAAM,CAAwC,KAAW;IACvE,OAAO,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAE,CAAC;AAClG,CAAC;AAFD,wBAEC;AAED;;;;;;GAMG;AACH,MAAa,SAAa,SAAQ,uBAAa;IAG7C,YAAoB,MAA8B;QAChD,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QADH,WAAM,GAAN,MAAM,CAAwB;QAF1C,WAAM,GAAQ,IAAI,CAAC;QAIzB,IAAI,CAAC,mBAAmB,CAAC,CAAC,YAAY,EAAE,EAAE;YACxC,IAAI,CAAC,YAAY,EAAE;gBACjB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;aACpB;iBAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACvB,0FAA0F;gBAC1F,wDAAwD;gBACvD,IAAY,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC1C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;aACvE;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACD,gBAAgB;IACT,GAAG,KAAQ,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9C,gBAAgB;IACT,GAAG,CAAC,KAAQ,IAAU,IAAA,0BAAa,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,gBAAgB;IACT,OAAO,KAAW,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC,CAAC,CAAC;CAChF;AAvBD,8BAuBC;AAOD;;GAEG;AACH,SAAgB,IAAI,CAAI,QAAyB,EAAE,QAAuB;IACxE,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC7C,IAAI,SAAS,EAAE;QACb,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IACrD,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACrC,QAAQ,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7C,OAAO,QAAQ,CAAC;AAClB,CAAC;AATD,oBASC;AAED,wEAAwE;AACxE,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B;;;;;;;;;;;;GAYG;AACH,SAAgB,eAAe,CAAC,EAAmB;IACjD,yFAAyF;IACzF,IAAI,iBAAiB,EAAE;QAAE,OAAO;KAAE;IAClC,iBAAiB,GAAG,IAAI,CAAC;IAEzB,MAAM,iBAAiB,GAAI,EAAU,CAAC,KAAK,CAAC,eAAe,CAAC;IAE5D,8FAA8F;IAC9F,kFAAkF;IAClF,MAAM,uBAAuB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC;IAEpE,yFAAyF;IACzF,MAAM,yBAAyB,GAAG,4BAAe,CAAC,gBAAgB,CAAC;IAEnE,8FAA8F;IAC9F,2DAA2D;IAC3D,SAAS,sBAAsB,CAAC,IAAU;QACxC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC9B,4BAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED,2FAA2F;IAC3F,4FAA4F;IAC5F,kBAAkB;IAClB,SAAS,wBAAwB,CAAC,IAAU;QAC1C,yBAAyB,CAAC,IAAI,CAAC,CAAC;QAEhC,6FAA6F;QAC7F,0CAA0C;QAC1C,iBAAiB,CAAC,iBAAiB,GAAG,uBAAuB,CAAC;QAC9D,IAAI;YACF,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;SACpB;gBAAS;YACR,iBAAiB,CAAC,iBAAiB,GAAG,sBAAsB,CAAC;SAC9D;IACH,CAAC;IAED,4EAA4E;IAC5E,iBAAiB,CAAC,iBAAiB,GAAG,sBAAsB,CAAC;IAC7D,4BAAe,CAAC,gBAAgB,GAAG,wBAAwB,CAAC;AAC9D,CAAC;AAxCD,0CAwCC"}

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

@@ -1,35 +1,3 @@
-/**
- * ObsArray extends a plain Observable to allow for more efficient observation of array changes.
- *
- * 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
- * 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.
- *
- *    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
- * ownership of those disposables that are added to it as array elements.
- */
 import { IDisposable, IDisposableOwnerT } from './dispose';
 import { Listener } from './emit';
 import { BaseObservable, Observable } from './observable';
@@ -37,49 +5,85 @@ import { BaseObservable, Observable } from './observable';
  * Either an observable or a plain array of T. This is useful for functions like dom.forEach()
  * which are convenient to have available for both.
  */
-export declare type MaybeObsArray<T> = BaseObservable<T[]> | T[];
+export type MaybeObsArray<T> = BaseObservable<T[]> | T[];
 /**
  * Info about a modification to ObsArray contents. It is included as a third argument to change
  * listeners when available. When not available, listeners should assume that the array changed
  * completely.
  */
 export interface IObsArraySplice<T> {
-    start: number;
+    start: number; /** asdf */
     numAdded: number;
     deleted: T[];
 }
-export declare type ISpliceListener<T, C> = (this: C, val: T[], prev: T[], change?: IObsArraySplice<T>) => void;
+export type ISpliceListener<T, C> = (this: C, val: T[], prev: T[], change?: IObsArraySplice<T>) => void;
 /**
- * ObsArray<T> is essentially an array-valued observable. The main difference is that it may be
+ * `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
+ * 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
+ * handling of the change by calling listeners with splice info in the third argument.
+ *
+ * `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.
+ * ```
+ *
+ * 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.
  */
 export declare class ObsArray<T> extends BaseObservable<T[]> {
     private _ownedItems?;
+    /**
+     * Adds a callback to listen to changes in the observable. In case of `ObsArray`, the listener
+     * gets additional information.
+     */
     addListener(callback: ISpliceListener<T, void>): Listener;
     addListener<C>(callback: ISpliceListener<T, C>, context: C): Listener;
+    /**
+     * Take ownership of an item added to this array. This should _only_ be used for array elements,
+     * not any unrelated items.
+     */
     autoDispose(value: T & IDisposable): T & IDisposable;
+    /** @override */
     dispose(): void;
+    /** @internal */
     protected _setWithSplice(value: T[], splice: IObsArraySplice<T>): void;
+    /** @internal */
     protected _disposeOwned(splice?: IObsArraySplice<T>): void;
 }
 /**
- * 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>()`.
  */
 export declare class MutableObsArray<T> extends ObsArray<T> {
+    /** Appends elements to the end and returns the new length (like `Array#push`). */
     push(...args: T[]): number;
+    /** Removes and returns the last element (like `Array#pop`). */
     pop(): T | undefined;
+    /** Prepends elements to the start and returns the new length (like `Array#unshift`). */
     unshift(...args: T[]): number;
+    /** Removes and returns the first element (like `Array#shift`). */
     shift(): T | undefined;
+    /**
+     * Removes and/or inserts elements at a given index and returns the removed elements (like
+     * `Array#splice`).
+     */
     splice(start: number, deleteCount?: number, ...newValues: T[]): T[];
 }
 /**
  * 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.
  */
 export declare function obsArray<T>(value?: T[]): MutableObsArray<T>;
 /**
- * See computedArray() below for documentation.
+ * See [`computedArray()`](#computedArray) for documentation.
  */
 export declare class ComputedArray<T, U> extends ObsArray<U> {
     private _mapper;
@@ -88,6 +92,7 @@ export declare class ComputedArray<T, U> extends ObsArray<U> {
     private _listener?;
     private _lastSplice?;
     constructor(obsArr: BaseObservable<T[]> | Observable<BaseObservable<T[]>>, _mapper: (item: T, index: number, arr: ComputedArray<T, U>) => U);
+    /** @internal */
     dispose(): void;
     private _syncMap;
     private _unsync;
@@ -96,25 +101,43 @@ export declare class ComputedArray<T, U> extends ObsArray<U> {
     private _recordChange;
 }
 /**
- * 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:
- *
- *    computedArray(obsArray, mapper)
- *
- * The result is entirely analogous to:
+ * 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)
+ * ```
  *
- *     computed((use) => use(obsArray).map(mapper))       // for ObsArray
- *     computed((use) => use(use(obsArray)).map(mapper))  // for Observable<ObsArray>
+ * 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 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.
  *
- * 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
+ * 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
  * 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.
  */
 export declare function computedArray<T, U>(obsArr: BaseObservable<T[]> | Observable<BaseObservable<T[]>>, mapper: (item: T, index: number, arr: ComputedArray<T, U>) => U): ObsArray<U>;
 /**
@@ -128,13 +151,28 @@ export declare function computedArray<T, U>(obsArr: BaseObservable<T[]> | Observ
  * observable will not be adjusted as the array changes, except to keep it valid.
  */
 export declare function makeLiveIndex<T>(owner: IDisposableOwnerT<LiveIndex> | null, obsArr: ObsArray<T>, initialIndex?: number): LiveIndex;
+/**
+ * An Observable that represents an index into an `ObsArray`, clamped to be in the valid range.
+ */
 export declare class LiveIndex extends Observable<number | null> {
     private _obsArray;
     private _listener;
     private _isLive;
     constructor(_obsArray: ObsArray<any>, initialIndex?: number);
+    /**
+     * Set the index, clamping it to a valid value.
+     */
     set(index: number | null): void;
+    /**
+     * 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: boolean): void;
+    /** @override */
     dispose(): void;
     private _onArrayChange;
 }