grainjs 1.0.2 → 1.1.0

package/dist/cjs/lib/dom.js

@@ -1,25 +1,11 @@
 "use strict";
-/**
- * dom.js provides a way to build a DOM tree easily.
- *
- * E.g.
- *  import {dom} from 'grainjs';
- *  dom('a#link.c1.c2', {'href': url}, 'Hello ', dom('span', 'world'));
- *    creates Node <a id="link" class="c1 c2" href={{url}}Hello <span>world</span></a>.
- *
- *  dom.frag(dom('span', 'Hello'), ['blah', dom('div', 'world')])
- *    creates document fragment with <span>Hello</span>blah<div>world</div>.
- *
- * DOM can also be created and modified inline during creation:
- *  dom('a#id.c1',
- *      dom.cls('c2'), dom.attr('href', url),
- *      dom.text('Hello '), dom('span', dom.text('world')))
- *    creates Node <a id="link" class="c1 c2" href={{url}}Hello <span>world</span></a>,
- *    identical to the first example above.
- */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -45,10 +31,48 @@ const _domImpl = require("./domImpl");
 const _domMethods = require("./domMethods");
 const domevent = require("./domevent");
 const domImpl_1 = require("./domImpl");
+/**
+ * `dom()` provides a way to build a DOM tree easily.
+ *
+ * The first argument is a string consisting of a lowercase tag name (e.g. `"div"`), with optional
+ * `"#foo"` suffix to add the ID `'foo'`, and zero or more `".bar"` suffixes to add a CSS class
+ * `'bar'`.
+ *
+ * The rest of the arguments are optional and may be any number, of these types:
+ *
+ * @param Nodes - become children of the created element
+ * @param strings - become text node children
+ * @param objects - Literal objects to set string attributes on the element.
+ *    E.g. `{title: "foo"}`.
+ * @param null - The values `null` and `undefined` values are ignored completely.
+ * @param Arrays - flattened with each item processed recursively
+ * @param functions - called with the element being built as the argument, for a chance to modify
+ *    the element as it's being created. Return values are processed recursively.
+ * @param functions - "dom methods" are a expressions such as `dom.attr('href', url)` or
+ *    `dom.hide(obs)`, which are special cases of the "functions" category.
+ *
+ * @example
+ * ```ts
+ * import {dom} from 'grainjs';
+ * dom('a', {href: url, className: 'myclass'}, 'Hello ', dom('strong', 'world'));
+ * ```
+ * creates HTML element `<a href={{url}} class="myclass">Hello <strong>world</strong></a>`.
+ *
+ * @example
+ * Here's an example equivalent to the one above, using dom methods `dom.cls`, `dom.attr`,
+ * `dom.text`. In reality, these methods are useful with observable values rather than constant
+ * strings.
+ * ```ts
+ *  dom('a', dom.attr('href', url), dom.cls('myclass'),
+ *      dom.text('Hello '), dom('strong', dom.text('world')));
+ * ```
+ *
+ * @see [DOM & Observables](/basics).
+ */
 // We just want to re-export _domImpl.dom, but to allow adding methods to it in a typesafe way,
 // TypeScript wants us to declare a real function in the same file.
 function dom(tagString, ...args) {
-    return domImpl_1.dom(tagString, ...args);
+    return (0, domImpl_1.dom)(tagString, ...args);
 }
 exports.dom = dom;
 // Additionally export all methods as properties of dom() function.

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

@@ -1 +1 @@
-{"version":3,"file":"dom.js","sourceRoot":"","sources":["../../../lib/dom.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;;;;;;;;;;;;AAEH,iGAAiG;AACjG,4CAA0B;AAC1B,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B;AAC7B,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAE3B,gDAAgD;AAChD,8CAA8C;AAC9C,4CAA4C;AAC5C,4CAA4C;AAC5C,sCAAsC;AACtC,4CAA4C;AAE5C,uCAAuC;AAEvC,uCAAkE;AAElE,+FAA+F;AAC/F,mEAAmE;AACnE,SAAgB,GAAG,CAAsB,SAAc,EAAE,GAAG,IAA4B;IACtF,OAAO,aAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;AAClC,CAAC;AAFD,kBAEC;AAED,mEAAmE;AACnE,WAAiB,GAAG;IACL,OAAG,GAAe,QAAQ,CAAC,GAAG,CAAC;IAC/B,QAAI,GAAc,QAAQ,CAAC,IAAI,CAAC;IAChC,UAAM,GAAY,QAAQ,CAAC,MAAM,CAAC;IAClC,QAAI,GAAc,QAAQ,CAAC,IAAI,CAAC;IAChC,WAAO,GAAW,QAAQ,CAAC,OAAO,CAAC;IAEnC,cAAU,GAAQ,WAAW,CAAC,UAAU,CAAC;IACzC,iBAAa,GAAK,WAAW,CAAC,aAAa,CAAC;IAC5C,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,mBAAe,GAAG,WAAW,CAAC,eAAe,CAAC;IAC9C,eAAW,GAAO,WAAW,CAAC,WAAW,CAAC;IAE1C,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,SAAK,GAAa,WAAW,CAAC,KAAK,CAAC;IACpC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,gBAAY,GAAM,WAAW,CAAC,YAAY,CAAC;IAC3C,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,SAAK,GAAa,WAAW,CAAC,KAAK,CAAC;IACpC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IACtC,OAAG,GAAe,WAAW,CAAC,GAAG,CAAC;IAClC,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IACtC,kBAAc,GAAI,YAAY,CAAC,cAAc,CAAC;IAC9C,eAAW,GAAO,YAAY,CAAC,WAAW,CAAC;IAC3C,oBAAgB,GAAG,YAAY,CAAC,gBAAgB,CAAC;IACjD,SAAK,GAAa,YAAY,CAAC,KAAK,CAAC;IACrC,cAAU,GAAQ,YAAY,CAAC,UAAU,CAAC;IAE1C,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IAEtC,UAAM,GAAY,aAAa,CAAC,MAAM,CAAC;IAEvC,UAAM,GAAY,QAAQ,CAAC,MAAM,CAAC;IAClC,MAAE,GAAgB,QAAQ,CAAC,EAAE,CAAC;IAC9B,eAAW,GAAO,QAAQ,CAAC,WAAW,CAAC;IACvC,WAAO,GAAW,QAAQ,CAAC,OAAO,CAAC;IACnC,aAAS,GAAS,QAAQ,CAAC,SAAS,CAAC;IACrC,cAAU,GAAQ,QAAQ,CAAC,UAAU,CAAC;IACtC,aAAS,GAAS,QAAQ,CAAC,SAAS,CAAC;AACpD,CAAC,EApDgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAoDnB"}
+{"version":3,"file":"dom.js","sourceRoot":"","sources":["../../../lib/dom.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iGAAiG;AACjG,4CAA0B;AAC1B,iDAA+B;AAC/B,gDAA8B;AAC9B,+CAA6B;AAC7B,+CAA6B;AAC7B,+CAA6B;AAC7B,6CAA2B;AAE3B,gDAAgD;AAChD,8CAA8C;AAC9C,4CAA4C;AAC5C,4CAA4C;AAC5C,sCAAsC;AACtC,4CAA4C;AAE5C,uCAAuC;AAEvC,uCAAkE;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,+FAA+F;AAC/F,mEAAmE;AACnE,SAAgB,GAAG,CAAsB,SAAc,EAAE,GAAG,IAA4B;IACtF,OAAO,IAAA,aAAI,EAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;AAClC,CAAC;AAFD,kBAEC;AAED,mEAAmE;AACnE,WAAiB,GAAG;IACL,OAAG,GAAe,QAAQ,CAAC,GAAG,CAAC;IAC/B,QAAI,GAAc,QAAQ,CAAC,IAAI,CAAC;IAChC,UAAM,GAAY,QAAQ,CAAC,MAAM,CAAC;IAClC,QAAI,GAAc,QAAQ,CAAC,IAAI,CAAC;IAChC,WAAO,GAAW,QAAQ,CAAC,OAAO,CAAC;IAEnC,cAAU,GAAQ,WAAW,CAAC,UAAU,CAAC;IACzC,iBAAa,GAAK,WAAW,CAAC,aAAa,CAAC;IAC5C,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,mBAAe,GAAG,WAAW,CAAC,eAAe,CAAC;IAC9C,eAAW,GAAO,WAAW,CAAC,WAAW,CAAC;IAE1C,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,SAAK,GAAa,WAAW,CAAC,KAAK,CAAC;IACpC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,gBAAY,GAAM,WAAW,CAAC,YAAY,CAAC;IAC3C,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,SAAK,GAAa,WAAW,CAAC,KAAK,CAAC;IACpC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IACtC,OAAG,GAAe,WAAW,CAAC,GAAG,CAAC;IAClC,aAAS,GAAS,WAAW,CAAC,SAAS,CAAC;IACxC,YAAQ,GAAU,WAAW,CAAC,QAAQ,CAAC;IACvC,QAAI,GAAc,WAAW,CAAC,IAAI,CAAC;IACnC,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IACtC,kBAAc,GAAI,YAAY,CAAC,cAAc,CAAC;IAC9C,eAAW,GAAO,YAAY,CAAC,WAAW,CAAC;IAC3C,oBAAgB,GAAG,YAAY,CAAC,gBAAgB,CAAC;IACjD,SAAK,GAAa,YAAY,CAAC,KAAK,CAAC;IACrC,cAAU,GAAQ,YAAY,CAAC,UAAU,CAAC;IAE1C,WAAO,GAAW,WAAW,CAAC,OAAO,CAAC;IAEtC,UAAM,GAAY,aAAa,CAAC,MAAM,CAAC;IAEvC,UAAM,GAAY,QAAQ,CAAC,MAAM,CAAC;IAClC,MAAE,GAAgB,QAAQ,CAAC,EAAE,CAAC;IAC9B,eAAW,GAAO,QAAQ,CAAC,WAAW,CAAC;IACvC,WAAO,GAAW,QAAQ,CAAC,OAAO,CAAC;IACnC,aAAS,GAAS,QAAQ,CAAC,SAAS,CAAC;IACrC,cAAU,GAAQ,QAAQ,CAAC,UAAU,CAAC;IACtC,aAAS,GAAS,QAAQ,CAAC,SAAS,CAAC;AACpD,CAAC,EApDgB,GAAG,GAAH,WAAG,KAAH,WAAG,QAoDnB"}

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

@@ -1,71 +1,79 @@
+import { MultiHolder } from './dispose';
+import { DomContents } from './domComputed';
+export interface IDomComponent {
+    buildDom(): DomContents;
+}
+export type DomComponentReturn = DomContents | IDomComponent;
+export type IDomCreateFunc<Args extends any[]> = (owner: MultiHolder, ...args: Args) => DomComponentReturn;
+export interface IDomCreateClass<Args extends any[]> {
+    create: IDomCreateFunc<Args>;
+    new (...args: Args): DomComponentReturn;
+}
+export type IDomCreator<Args extends any[]> = IDomCreateFunc<Args> | IDomCreateClass<Args>;
+export type DomCreatorArgs<T> = T extends (owner: MultiHolder, ...args: infer P) => any ? P : (T extends new (...args: infer P) => any ? P : never);
 /**
- * UI components that can be inserted into dom().
+ * UI components that can be inserted into `dom()`.
  *
- * Components are created and inserted using dom.create():
+ * Components are created and inserted using `dom.create()`:
+ * ```ts
+ * dom('div',
+ *   dom.create(MyWidget, ...myArgs),        // Calls MyWidget.create(owner, ...myArgs)
+ *   dom.create(createMyWidget, ...myArgs),  // Calls createMyWidget(owner, ...myArgs)
+ * )
+ * ```
  *
- *    dom('div',
- *      dom.create(MyWidget, ...myArgs),        // Calls MyWidget.create(owner, ...myArgs)
- *      dom.create(createMyWidget, ...myArgs),  // Calls createMyWidget(owner, ...myArgs)
- *    )
- *
- * The first argument may be a function, which is called directly, or a class with a .create()
+ * The first argument may be a function, which is called directly, or a class with a `.create()`
  * static method, in which case that's what gets called.
  *
  * In both cases, the call gets a first argument of `owner` followed by the rest of the arguments
- * to dom.create(). The `owner` is a MultiHolder that will own this component. This works
+ * to `dom.create()`. The `owner` is a `MultiHolder` that will own this component. This works
  * naturally with any class that derives from Disposable, since it then has a suitable static
- * create() method.
+ * `create()` method.
  *
  * Function-based components may use owner to easily handle disposal. For example:
- *
- *    dom.create(createMyWidget)
- *    function createMyWidget(owner) {
- *      const foo = Foo.create(owner);
- *      return dom('div', foo.getTitle());
- *    }
- *
- * The `owner` argument is the main benefit of dom.create(). Logically, the owner is the DOM where
+ * ```ts
+ * dom.create(createMyWidget)
+ * function createMyWidget(owner) {
+ *   const foo = Foo.create(owner);
+ *   return dom('div', foo.getTitle());
+ * }
+ * ```
+ *
+ * The `owner` argument is the main benefit of `dom.create()`. Logically, the owner is the DOM where
  * the component is attached. When the parent DOM element is disposed, so is the component.
  *
- *    [Explanation] To understand why the syntax is such, consider a potential alternative such as:
+ * :::info Explanation
  *
- *       dom('div', _insert_(new Comp1()), _insert_(new Comp2(...args)))
+ * To understand why the syntax is such, consider a potential alternative such as:
+ * ```ts
+ * dom('div', _insert_(new Comp1()), _insert_(new Comp2(...args)))
+ * ```
  *
- *    In both cases, the constructor for Comp1 runs before the constructor for Comp2. What happens
- *    when Comp2's constructor throws an exception? In the second case, nothing yet owns the
- *    created Comp1 component, and it will never get cleaned up. With dom.create(), the DOM
- *    gets ownership of Comp1 early enough and will dispose it.
+ * In both cases, the constructor for Comp1 runs before the constructor for Comp2. What happens
+ * when Comp2's constructor throws an exception? In the second case, nothing yet owns the
+ * created Comp1 component, and it will never get cleaned up. With `dom.create()`, the DOM
+ * gets ownership of Comp1 early enough and will dispose it.
+ *
+ * :::
  *
  * A function component may return DOM directly. A class component returns the class instance,
- * which must have a .buildDom() method which will be called right after the constructor to get
+ * which must have a `.buildDom()` method which will be called right after the constructor to get
  * the DOM. Note that buildDom is only called once.
  *
- * A function component may also return an object with .buildDom(). So these are equivalent:
- *
- *    dom.create(MyWidget)
- *    dom.create((owner) => MyWidget.create(owner))
+ * A function component may also return an object with `.buildDom()`. So these are equivalent:
+ * ```ts
+ * dom.create(MyWidget)
+ * dom.create((owner) => MyWidget.create(owner))
+ * ```
  *
  * Note that ownership should be handled using the `owner` argument. Don't do this:
+ * ```ts
+ * // NON-EXAMPLE: Nothing will dispose the created object:
+ * // dom.create(() => new MyWidget());
+ * ```
  *
- *    // NON-EXAMPLE: Nothing will dispose the created object:
- *    // dom.create(() => new MyWidget());
- *
- * The returned DOM may includes Nodes, strings, and domComputed() values, as well as arrays of
- * any of these. In other words, any DomArg goes except DomMethods. All the DOM returned will be
+ * The returned DOM may includes Nodes, strings, and `domComputed()` values, as well as arrays of
+ * any of these. In other words, any `DomArg` goes except `DomMethods`. All the DOM returned will be
  * disposed when the containing element is disposed, followed by the `owner` itself.
  */
-import { MultiHolder } from './dispose';
-import { DomContents } from './domComputed';
-export interface IDomComponent {
-    buildDom(): DomContents;
-}
-export declare type DomComponentReturn = DomContents | IDomComponent;
-export declare type IDomCreateFunc<Args extends any[]> = (owner: MultiHolder, ...args: Args) => DomComponentReturn;
-export interface IDomCreateClass<Args extends any[]> {
-    create: IDomCreateFunc<Args>;
-    new (...args: Args): DomComponentReturn;
-}
-export declare type IDomCreator<Args extends any[]> = IDomCreateFunc<Args> | IDomCreateClass<Args>;
-declare type DomCreatorArgs<T> = T extends (owner: MultiHolder, ...args: infer P) => any ? P : (T extends new (...args: infer P) => any ? P : never);
 export declare function create<Fn extends IDomCreator<any[]>>(fn: Fn, ...args: DomCreatorArgs<Fn>): DomContents;
-export {};

package/dist/cjs/lib/domComponent.js

@@ -2,8 +2,73 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = void 0;
 const domComputed_1 = require("./domComputed");
+/**
+ * UI components that can be inserted into `dom()`.
+ *
+ * Components are created and inserted using `dom.create()`:
+ * ```ts
+ * dom('div',
+ *   dom.create(MyWidget, ...myArgs),        // Calls MyWidget.create(owner, ...myArgs)
+ *   dom.create(createMyWidget, ...myArgs),  // Calls createMyWidget(owner, ...myArgs)
+ * )
+ * ```
+ *
+ * The first argument may be a function, which is called directly, or a class with a `.create()`
+ * static method, in which case that's what gets called.
+ *
+ * In both cases, the call gets a first argument of `owner` followed by the rest of the arguments
+ * to `dom.create()`. The `owner` is a `MultiHolder` that will own this component. This works
+ * naturally with any class that derives from Disposable, since it then has a suitable static
+ * `create()` method.
+ *
+ * Function-based components may use owner to easily handle disposal. For example:
+ * ```ts
+ * dom.create(createMyWidget)
+ * function createMyWidget(owner) {
+ *   const foo = Foo.create(owner);
+ *   return dom('div', foo.getTitle());
+ * }
+ * ```
+ *
+ * The `owner` argument is the main benefit of `dom.create()`. Logically, the owner is the DOM where
+ * the component is attached. When the parent DOM element is disposed, so is the component.
+ *
+ * :::info Explanation
+ *
+ * To understand why the syntax is such, consider a potential alternative such as:
+ * ```ts
+ * dom('div', _insert_(new Comp1()), _insert_(new Comp2(...args)))
+ * ```
+ *
+ * In both cases, the constructor for Comp1 runs before the constructor for Comp2. What happens
+ * when Comp2's constructor throws an exception? In the second case, nothing yet owns the
+ * created Comp1 component, and it will never get cleaned up. With `dom.create()`, the DOM
+ * gets ownership of Comp1 early enough and will dispose it.
+ *
+ * :::
+ *
+ * A function component may return DOM directly. A class component returns the class instance,
+ * which must have a `.buildDom()` method which will be called right after the constructor to get
+ * the DOM. Note that buildDom is only called once.
+ *
+ * A function component may also return an object with `.buildDom()`. So these are equivalent:
+ * ```ts
+ * dom.create(MyWidget)
+ * dom.create((owner) => MyWidget.create(owner))
+ * ```
+ *
+ * Note that ownership should be handled using the `owner` argument. Don't do this:
+ * ```ts
+ * // NON-EXAMPLE: Nothing will dispose the created object:
+ * // dom.create(() => new MyWidget());
+ * ```
+ *
+ * The returned DOM may includes Nodes, strings, and `domComputed()` values, as well as arrays of
+ * any of these. In other words, any `DomArg` goes except `DomMethods`. All the DOM returned will be
+ * disposed when the containing element is disposed, followed by the `owner` itself.
+ */
 function create(fn, ...args) {
-    return domComputed_1.domComputedOwned(null, (owner) => {
+    return (0, domComputed_1.domComputedOwned)(null, (owner) => {
         const value = ('create' in fn) ?
             fn.create(owner, ...args) :
             fn(owner, ...args);

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

@@ -1 +1 @@
-{"version":3,"file":"domComponent.js","sourceRoot":"","sources":["../../../lib/domComponent.ts"],"names":[],"mappings":";;;AAyDA,+CAA4D;AAuB5D,SAAgB,MAAM,CAAgC,EAAM,EAAE,GAAG,IAAwB;IACvF,OAAO,8BAAgB,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;QACtC,MAAM,KAAK,GAAuB,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;YACjD,EAA6B,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;YACtD,EAA4B,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AARD,wBAQC"}
+{"version":3,"file":"domComponent.js","sourceRoot":"","sources":["../../../lib/domComponent.ts"],"names":[],"mappings":";;;AACA,+CAA4D;AAuB5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,SAAgB,MAAM,CAAgC,EAAM,EAAE,GAAG,IAAwB;IACvF,OAAO,IAAA,8BAAgB,EAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;QACtC,MAAM,KAAK,GAAuB,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC;YACjD,EAA6B,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;YACtD,EAA4B,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;QAChD,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC;YAClE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AARD,wBAQC"}

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

@@ -1,8 +1,8 @@
 import { BindableValue } from './binding';
 import { MultiHolder } from './dispose';
 import { DomArg, DomMethod } from './domImpl';
-export declare type DomComputed = [Node, Node, DomMethod];
-export declare type DomContents = Node | string | DomComputed | void | null | undefined | IDomContentsArray;
+export type DomComputed = [Node, Node, DomMethod];
+export type DomContents = Node | string | DomComputed | void | null | undefined | IDomContentsArray;
 export interface IDomContentsArray extends Array<DomContents> {
 }
 /**
@@ -21,29 +21,36 @@ export declare function replaceContent(nodeBefore: Node, nodeAfter: Node, conten
  * changes, previous content is disposed and removed, and new content added in its place.
  *
  * The following are roughly equivalent:
- *  (A) domComputed(nlinesObs, nlines => nlines > 1 ? dom('textarea') : dom('input'));
- *  (B) domComputed(use => use(nlinesObs) > 1 ? dom('textarea') : dom('input'));
- *  (C) domComputed(use => use(nlinesObs) > 1, isTall => isTall ? dom('textarea') : dom('input'));
+ * ```ts
+ * // (A)
+ * domComputed(nlinesObs, nlines => nlines > 1 ? dom('textarea') : dom('input'))
+ * // (B)
+ * domComputed(use => use(nlinesObs) > 1 ? dom('textarea') : dom('input'))
+ * // (C)
+ * domComputed(use => use(nlinesObs) > 1, isTall => isTall ? dom('textarea') : dom('input'))
+ * ```
  *
  * Here, (C) is best. Both (A) and (B) would rebuild DOM for any change in nlinesObs, but (C)
  * encapsulates meaningful changes in the observable, and only recreates DOM when necessary.
  *
  * Syntax (B), without the second argument, may be useful in cases of DOM depending on several
  * observables, e.g.
+ * ```ts
+ * domComputed(use => use(readonlyObs) ? dom('div') :
+ *     (use(nlinesObs) > 1 ? dom('textarea') : dom('input')))
+ * ```
  *
- *    domComputed(use => use(readonlyObs) ? dom('div') :
- *                          (use(nlinesObs) > 1 ? dom('textarea') : dom('input')));
- *
- * If the argument is not an observable, domComputed() may but should not be used. The following
+ * If the argument is not an observable, `domComputed()` may but should not be used. The following
  * are equivalent:
- *
- *    dom(..., domComputed(listValue, list => `Have ${list.length} items`), ...)
- *    dom(..., `Have ${listValue.length} items`, ...)
+ * ```ts
+ * dom(..., domComputed(listValue, list => `Have ${list.length} items`), ...);
+ * dom(..., `Have ${listValue.length} items`, ...);
+ * ```
  *
  * In this case, the latter is preferred as the clearly simpler one.
  *
- * @param valueObs: Observable or function for a computed.
- * @param contentFunc: Function called with the result of valueObs as the input, and
+ * @param valueObs - Observable or function for a computed.
+ * @param contentFunc - Function called with the result of valueObs as the input, and
  *    returning DOM as output. If omitted, defaults to the identity function.
  */
 export declare function domComputed(valueObs: BindableValue<Exclude<DomArg, DomMethod>>): DomComputed;
@@ -53,7 +60,7 @@ export declare function domComputed<T>(valueObs: BindableValue<T>, contentFunc:
  * used to take ownership of objects created by the callback. These will be disposed before each
  * new call to the callback, and when the containing DOM is disposed.
  *
- *    domComputedOwned(valueObs, (owner, value) => Editor.create(owner, value).renderSomething());
+ * `domComputedOwned(valueObs, (owner, value) => Editor.create(owner, value).renderSomething())`
  */
 export declare function domComputedOwned<T>(valueObs: BindableValue<T>, contentFunc: (owner: MultiHolder, val: T) => DomContents): DomComputed;
 /**
@@ -64,26 +71,29 @@ export declare function domComputedOwned<T>(valueObs: BindableValue<T>, contentF
  * Note that if the observable changes between different truthy values, contentFunc gets called
  * for each value, and previous content gets destroyed. To consider all truthy values the same,
  * use an observable that returns a proper boolean, e.g.
- *
+ * ```ts
  *    dom.maybe(use => Boolean(use(fooObs)), () => dom(...));
+ * ```
  *
  * As with domComputed(), dom.maybe() may but should not be used when the argument is not an
  * observable or function. The following are equivalent:
- *
+ * ```ts
  *    dom(..., dom.maybe(myValue, () => dom(...)));
  *    dom(..., myValue ? dom(...) : null);
+ * ```
  *
  * The latter is preferred for being simpler.
  *
- * @param boolValueObs: Observable or function for a computed.
- * @param contentFunc: Called with the result of boolValueObs when it is truthy. Should return DOM.
+ * @param boolValueObs - Observable or function for a computed.
+ * @param contentFunc - Called with the result of boolValueObs when it is truthy. Should return DOM.
  */
 export declare function maybe<T>(boolValueObs: BindableValue<T>, contentFunc: (val: NonNullable<T>) => DomContents): DomComputed;
 /**
  * Like maybe(), but the callback gets an additional first argument, owner, which may be used to
  * take ownership of objects created by the callback. These will be disposed before each new call
  * to the callback, and when the condition becomes false or the containing DOM gets disposed.
- *
- *    maybeOwned(showEditor, (owner) => Editor.create(owner).renderSomething());
+ * ```ts
+ *    maybeOwned(showEditor, (owner) => Editor.create(owner).renderSomething())
+ * ```
  */
 export declare function maybeOwned<T>(boolValueObs: BindableValue<T>, contentFunc: (owner: MultiHolder, val: NonNullable<T>) => DomContents): DomComputed;

package/dist/cjs/lib/domComputed.js

@@ -18,11 +18,11 @@ function replaceContent(nodeBefore, nodeAfter, content) {
         let next;
         for (let n = nodeBefore.nextSibling; n && n !== nodeAfter; n = next) {
             next = n.nextSibling;
-            domDispose_1.domDispose(n);
+            (0, domDispose_1.domDispose)(n);
             elem.removeChild(n);
         }
         if (content) {
-            elem.insertBefore(content instanceof browserGlobals_1.G.Node ? content : domImpl_1.frag(content), nodeAfter);
+            elem.insertBefore(content instanceof browserGlobals_1.G.Node ? content : (0, domImpl_1.frag)(content), nodeAfter);
         }
     }
 }
@@ -33,7 +33,7 @@ function domComputed(valueObs, contentFunc = identity) {
     // Function is added after markerPre and markerPost, so that it runs once they have already been
     // attached to elem (the parent element).
     return [markerPre, markerPost, (elem) => {
-            binding_1.subscribeElem(markerPost, valueObs, (value) => replaceContent(markerPre, markerPost, contentFunc(value)));
+            (0, binding_1.subscribeElem)(markerPost, valueObs, (value) => replaceContent(markerPre, markerPost, contentFunc(value)));
         }];
 }
 exports.domComputed = domComputed;
@@ -42,12 +42,12 @@ exports.domComputed = domComputed;
  * used to take ownership of objects created by the callback. These will be disposed before each
  * new call to the callback, and when the containing DOM is disposed.
  *
- *    domComputedOwned(valueObs, (owner, value) => Editor.create(owner, value).renderSomething());
+ * `domComputedOwned(valueObs, (owner, value) => Editor.create(owner, value).renderSomething())`
  */
 function domComputedOwned(valueObs, contentFunc) {
     const holder = dispose_1.Holder.create(null);
     const [markerPre, markerPost, func] = domComputed(valueObs, (val) => contentFunc(dispose_1.MultiHolder.create(holder), val));
-    domDispose_1.autoDisposeElem(markerPost, holder);
+    (0, domDispose_1.autoDisposeElem)(markerPost, holder);
     return [markerPre, markerPost, func];
 }
 exports.domComputedOwned = domComputedOwned;
@@ -60,19 +60,21 @@ function identity(arg) { return arg; }
  * Note that if the observable changes between different truthy values, contentFunc gets called
  * for each value, and previous content gets destroyed. To consider all truthy values the same,
  * use an observable that returns a proper boolean, e.g.
- *
+ * ```ts
  *    dom.maybe(use => Boolean(use(fooObs)), () => dom(...));
+ * ```
  *
  * As with domComputed(), dom.maybe() may but should not be used when the argument is not an
  * observable or function. The following are equivalent:
- *
+ * ```ts
  *    dom(..., dom.maybe(myValue, () => dom(...)));
  *    dom(..., myValue ? dom(...) : null);
+ * ```
  *
  * The latter is preferred for being simpler.
  *
- * @param boolValueObs: Observable or function for a computed.
- * @param contentFunc: Called with the result of boolValueObs when it is truthy. Should return DOM.
+ * @param boolValueObs - Observable or function for a computed.
+ * @param contentFunc - Called with the result of boolValueObs when it is truthy. Should return DOM.
  */
 function maybe(boolValueObs, contentFunc) {
     return domComputed(boolValueObs, (value) => value ? contentFunc(value) : null);
@@ -82,8 +84,9 @@ exports.maybe = maybe;
  * Like maybe(), but the callback gets an additional first argument, owner, which may be used to
  * take ownership of objects created by the callback. These will be disposed before each new call
  * to the callback, and when the condition becomes false or the containing DOM gets disposed.
- *
- *    maybeOwned(showEditor, (owner) => Editor.create(owner).renderSomething());
+ * ```ts
+ *    maybeOwned(showEditor, (owner) => Editor.create(owner).renderSomething())
+ * ```
  */
 function maybeOwned(boolValueObs, contentFunc) {
     return domComputedOwned(boolValueObs, (owner, value) => value ? contentFunc(owner, value) : null);

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

@@ -1 +1 @@
-{"version":3,"file":"domComputed.js","sourceRoot":"","sources":["../../../lib/domComputed.ts"],"names":[],"mappings":";;;AAAA,uCAAuD;AACvD,uCAA8C;AAC9C,6CAAyD;AACzD,uCAAkD;AAElD,mFAAmF;AACnF,qDAAmC;AAUnC;;;;GAIG;AACH,SAAgB,cAAc,CAAC,UAAgB,EAAE,SAAe,EAAE,OAAoB;IACpF,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IACnC,IAAI,IAAI,EAAE;QACR,IAAI,IAAI,CAAC;QACT,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE;YACnE,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;YACrB,uBAAU,CAAC,CAAC,CAAC,CAAC;YACd,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACrB;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,YAAY,CAAC,OAAO,YAAY,kBAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;SACnF;KACF;AACH,CAAC;AAbD,wCAaC;AAyCD,SAAgB,WAAW,CACzB,QAA0B,EAAE,cAAuC,QAAe;IAElF,MAAM,SAAS,GAAG,kBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,kBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEjD,gGAAgG;IAChG,yCAAyC;IACzC,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC,IAAU,EAAE,EAAE;YAC5C,uBAAa,CAAC,UAAU,EAAE,QAAQ,EAChC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,kCAYC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAA0B,EAAE,WAAwD;IAEpF,MAAM,MAAM,GAAG,gBAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,QAAQ,EACxD,CAAC,GAAM,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5D,4BAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACpC,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AARD,4CAQC;AAED,SAAS,QAAQ,CAAI,GAAM,IAAO,OAAO,GAAG,CAAC,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,KAAK,CAAI,YAA8B,EACnD,WAAiD;IACnD,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAClF,CAAC;AAHD,sBAGC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAI,YAA8B,EACxD,WAAqE;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,KAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,CAAC;AAHD,gCAGC"}
+{"version":3,"file":"domComputed.js","sourceRoot":"","sources":["../../../lib/domComputed.ts"],"names":[],"mappings":";;;AAAA,uCAAuD;AACvD,uCAA8C;AAC9C,6CAAyD;AACzD,uCAAkD;AAElD,mFAAmF;AACnF,qDAAmC;AAUnC;;;;GAIG;AACH,SAAgB,cAAc,CAAC,UAAgB,EAAE,SAAe,EAAE,OAAoB;IACpF,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC;IACnC,IAAI,IAAI,EAAE;QACR,IAAI,IAAI,CAAC;QACT,KAAK,IAAI,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE;YACnE,IAAI,GAAG,CAAC,CAAC,WAAW,CAAC;YACrB,IAAA,uBAAU,EAAC,CAAC,CAAC,CAAC;YACd,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACrB;QACD,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,YAAY,CAAC,OAAO,YAAY,kBAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,cAAI,EAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;SACnF;KACF;AACH,CAAC;AAbD,wCAaC;AAgDD,SAAgB,WAAW,CACzB,QAA0B,EAAE,cAAuC,QAAe;IAElF,MAAM,SAAS,GAAG,kBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,kBAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEjD,gGAAgG;IAChG,yCAAyC;IACzC,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC,IAAU,EAAE,EAAE;YAC5C,IAAA,uBAAa,EAAC,UAAU,EAAE,QAAQ,EAChC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,kCAYC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,QAA0B,EAAE,WAAwD;IAEpF,MAAM,MAAM,GAAG,gBAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,QAAQ,EACxD,CAAC,GAAM,EAAE,EAAE,CAAC,WAAW,CAAC,qBAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC5D,IAAA,4BAAe,EAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACpC,OAAO,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AARD,4CAQC;AAED,SAAS,QAAQ,CAAI,GAAM,IAAO,OAAO,GAAG,CAAC,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,KAAK,CAAI,YAA8B,EACnD,WAAiD;IACnD,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAClF,CAAC;AAHD,sBAGC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CAAI,YAA8B,EACxD,WAAqE;IACvE,OAAO,gBAAgB,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,KAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,CAAC;AAHD,gCAGC"}

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

@@ -1,5 +1,6 @@
 import { IDisposable } from './dispose';
-export declare type INodeFunc = (node: Node) => void;
+export type INodeFunc = (node: Node) => void;
+/** @internal */
 export declare function _disposeNode(node: Node): void;
 export interface IDomDisposeHooks {
     disposeRecursive: (node: Node) => void;
@@ -17,26 +18,40 @@ export declare const domDisposeHooks: IDomDisposeHooks;
  * It is automatically called if one of the function arguments to dom() throws an exception during
  * element creation. This way any onDispose() handlers set on the unfinished element get called.
  *
- * @param {Node} node: The element to run disposers on.
+ * @param node - The element to run disposers on.
  */
 export declare function domDispose(node: Node): void;
 /**
- * Associate a disposerFunc with a DOM element. It will be called when the element is disposed
- * using domDispose() on it or any of its parents. If onDispose is called multiple times, all
- * disposerFuncs will be called in reverse order.
- * @param {Element} elem: The element to associate the disposer with.
- * @param {Function} disposerFunc(elem): Will be called when domDispose() is called on the
- *    element or its ancestor.
+ * Associate a disposer function with a DOM element. It will be called when the element is disposed
+ * using `domDispose()` on it or any of its parents. If called multiple times, all
+ * disposer functions will be called in reverse order.
+ *
  * Note that it is not necessary usually to dispose event listeners attached to an element (e.g.
- * with dom.on()) since their lifetime is naturally limited to the lifetime of the element.
+ * with `dom.on()`) since their lifetime is naturally limited to the lifetime of the element.
+ *
+ * @param elem - The element to associate the disposer with.
+ * @param disposerFunc - Will be called when `domDispose()` is called on the element or its ancestor.
  */
 export declare function onDisposeElem(elem: Node, disposerFunc: INodeFunc): void;
+/**
+ * Associate a disposer function with a DOM element. It will be called when the element is disposed
+ * using `domDispose()` on it or any of its parents. If called multiple times, all
+ * disposer functions will be called in reverse order.
+ *
+ * @param disposerFunc - Will be called when `domDispose()` is called on the element or its ancestor.
+ */
 export declare function onDispose(disposerFunc: INodeFunc): (elem: Node) => void;
 /**
- * Make the given element own the disposable, and call its dispose method when domDispose() is
+ * Make the given element own the disposable, and call its dispose method when `domDispose()` is
  * called on the element or any of its parents.
- * @param {Element} elem: The element to own the disposable.
- * @param {Disposable} disposable: Anything with a .dispose() method.
+ * @param elem - The element to own the disposable.
+ * @param disposable - Anything with a `.dispose()` method.
  */
 export declare function autoDisposeElem(elem: Node, disposable: IDisposable | null): void;
+/**
+ * Make the given element own the disposable, and call its dispose method when `domDispose()` is
+ * called on the element or any of its parents.
+ *
+ * @param disposable - Anything with a `.dispose()` method.
+ */
 export declare function autoDispose(disposable: IDisposable | null): ((elem: Node) => void) | undefined;

package/dist/cjs/lib/domDispose.js

@@ -26,6 +26,7 @@ function _walkDom(elem, visitFunc) {
     visitFunc(elem);
 }
 // Internal helper to run all disposers for a single element.
+/** @internal */
 function _disposeNode(node) {
     let disposer = _disposeMap.get(node);
     if (disposer) {
@@ -58,21 +59,22 @@ exports.domDisposeHooks = {
  * It is automatically called if one of the function arguments to dom() throws an exception during
  * element creation. This way any onDispose() handlers set on the unfinished element get called.
  *
- * @param {Node} node: The element to run disposers on.
+ * @param node - The element to run disposers on.
  */
 function domDispose(node) {
     exports.domDisposeHooks.disposeRecursive(node);
 }
 exports.domDispose = domDispose;
 /**
- * Associate a disposerFunc with a DOM element. It will be called when the element is disposed
- * using domDispose() on it or any of its parents. If onDispose is called multiple times, all
- * disposerFuncs will be called in reverse order.
- * @param {Element} elem: The element to associate the disposer with.
- * @param {Function} disposerFunc(elem): Will be called when domDispose() is called on the
- *    element or its ancestor.
+ * Associate a disposer function with a DOM element. It will be called when the element is disposed
+ * using `domDispose()` on it or any of its parents. If called multiple times, all
+ * disposer functions will be called in reverse order.
+ *
  * Note that it is not necessary usually to dispose event listeners attached to an element (e.g.
- * with dom.on()) since their lifetime is naturally limited to the lifetime of the element.
+ * with `dom.on()`) since their lifetime is naturally limited to the lifetime of the element.
+ *
+ * @param elem - The element to associate the disposer with.
+ * @param disposerFunc - Will be called when `domDispose()` is called on the element or its ancestor.
  */
 function onDisposeElem(elem, disposerFunc) {
     const prevDisposer = _disposeMap.get(elem);
@@ -82,15 +84,22 @@ function onDisposeElem(elem, disposerFunc) {
     }
 }
 exports.onDisposeElem = onDisposeElem;
+/**
+ * Associate a disposer function with a DOM element. It will be called when the element is disposed
+ * using `domDispose()` on it or any of its parents. If called multiple times, all
+ * disposer functions will be called in reverse order.
+ *
+ * @param disposerFunc - Will be called when `domDispose()` is called on the element or its ancestor.
+ */
 function onDispose(disposerFunc) {
     return (elem) => onDisposeElem(elem, disposerFunc);
 }
 exports.onDispose = onDispose;
 /**
- * Make the given element own the disposable, and call its dispose method when domDispose() is
+ * Make the given element own the disposable, and call its dispose method when `domDispose()` is
  * called on the element or any of its parents.
- * @param {Element} elem: The element to own the disposable.
- * @param {Disposable} disposable: Anything with a .dispose() method.
+ * @param elem - The element to own the disposable.
+ * @param disposable - Anything with a `.dispose()` method.
  */
 function autoDisposeElem(elem, disposable) {
     if (disposable) {
@@ -98,6 +107,12 @@ function autoDisposeElem(elem, disposable) {
     }
 }
 exports.autoDisposeElem = autoDisposeElem;
+/**
+ * Make the given element own the disposable, and call its dispose method when `domDispose()` is
+ * called on the element or any of its parents.
+ *
+ * @param disposable - Anything with a `.dispose()` method.
+ */
 function autoDispose(disposable) {
     if (disposable) {
         return (elem) => autoDisposeElem(elem, disposable);

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

@@ -1 +1 @@
-{"version":3,"file":"domDispose.js","sourceRoot":"","sources":["../../../lib/domDispose.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACH,MAAM,WAAW,GAAuC,IAAI,OAAO,EAAE,CAAC;AAItE,4FAA4F;AAC5F,mCAAmC;AACnC,SAAS,QAAQ,CAAC,IAAU,EAAE,SAAoB;IAChD,IAAI,CAAC,GAAc,IAAI,CAAC,UAAU,CAAC;IACnC,OAAO,CAAC,EAAE;QACR,4FAA4F;QAC5F,gCAAgC;QAChC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACvB,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;KACnB;IACD,SAAS,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,6DAA6D;AAC7D,SAAgB,YAAY,CAAC,IAAU;IACrC,IAAI,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,QAAQ,EAAE;QACZ,IAAI,GAAG,GAAmB,IAAI,CAAC;QAC/B,GAAG;YACD,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACxB,QAAQ,CAAC,IAAI,CAAC,CAAC;YACf,qEAAqE;YACrE,GAAG,GAAG,QAAQ,CAAC;YACf,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjC,QAAQ,QAAQ,EAAE;KACpB;AACH,CAAC;AAZD,oCAYC;AAED,SAAS,qBAAqB,CAAC,IAAU;IACvC,QAAQ,CAAC,IAAI,EAAE,uBAAe,CAAC,WAAW,CAAC,CAAC;AAC9C,CAAC;AAOD;;;GAGG;AACU,QAAA,eAAe,GAAqB;IAC/C,WAAW,EAAE,YAAY;IACzB,gBAAgB,EAAE,qBAAqB;CACxC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,IAAU;IACnC,uBAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,gCAEC;AAED;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAAC,IAAU,EAAE,YAAuB;IAC/D,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3C,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACpC,IAAI,YAAY,EAAE;QAChB,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;KAC7C;AACH,CAAC;AAND,sCAMC;AACD,SAAgB,SAAS,CAAC,YAAuB;IAC/C,OAAO,CAAC,IAAU,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC3D,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,IAAU,EAAE,UAA4B;IACtE,IAAI,UAAU,EAAE;QACd,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;KACjD;AACH,CAAC;AAJD,0CAIC;AACD,SAAgB,WAAW,CAAC,UAA4B;IACtD,IAAI,UAAU,EAAE;QACd,OAAO,CAAC,IAAU,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;KAC1D;AACH,CAAC;AAJD,kCAIC"}
+{"version":3,"file":"domDispose.js","sourceRoot":"","sources":["../../../lib/domDispose.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;GAUG;AACH,MAAM,WAAW,GAAuC,IAAI,OAAO,EAAE,CAAC;AAItE,4FAA4F;AAC5F,mCAAmC;AACnC,SAAS,QAAQ,CAAC,IAAU,EAAE,SAAoB;IAChD,IAAI,CAAC,GAAc,IAAI,CAAC,UAAU,CAAC;IACnC,OAAO,CAAC,EAAE;QACR,4FAA4F;QAC5F,gCAAgC;QAChC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACvB,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC;KACnB;IACD,SAAS,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,6DAA6D;AAC7D,gBAAgB;AAChB,SAAgB,YAAY,CAAC,IAAU;IACrC,IAAI,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,QAAQ,EAAE;QACZ,IAAI,GAAG,GAAmB,IAAI,CAAC;QAC/B,GAAG;YACD,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACxB,QAAQ,CAAC,IAAI,CAAC,CAAC;YACf,qEAAqE;YACrE,GAAG,GAAG,QAAQ,CAAC;YACf,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACjC,QAAQ,QAAQ,EAAE;KACpB;AACH,CAAC;AAZD,oCAYC;AAED,SAAS,qBAAqB,CAAC,IAAU;IACvC,QAAQ,CAAC,IAAI,EAAE,uBAAe,CAAC,WAAW,CAAC,CAAC;AAC9C,CAAC;AAOD;;;GAGG;AACU,QAAA,eAAe,GAAqB;IAC/C,WAAW,EAAE,YAAY;IACzB,gBAAgB,EAAE,qBAAqB;CACxC,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAC,IAAU;IACnC,uBAAe,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,gCAEC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,aAAa,CAAC,IAAU,EAAE,YAAuB;IAC/D,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC3C,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACpC,IAAI,YAAY,EAAE;QAChB,WAAW,CAAC,GAAG,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;KAC7C;AACH,CAAC;AAND,sCAMC;AAED;;;;;;GAMG;AACH,SAAgB,SAAS,CAAC,YAAuB;IAC/C,OAAO,CAAC,IAAU,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC3D,CAAC;AAFD,8BAEC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,IAAU,EAAE,UAA4B;IACtE,IAAI,UAAU,EAAE;QACd,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;KACjD;AACH,CAAC;AAJD,0CAIC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,UAA4B;IACtD,IAAI,UAAU,EAAE;QACd,OAAO,CAAC,IAAU,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;KAC1D;AACH,CAAC;AAJD,kCAIC"}