@thi.ng/rdom 0.8.5 → 0.8.6

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2021-12-13T10:26:00Z
+- **Last updated**: 2022-03-11T12:13:49Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -173,7 +173,7 @@ node --experimental-repl-await
 > const rdom = await import("@thi.ng/rdom");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 4.05 KB
+Package sizes (gzipped, pre-treeshake): ESM: 4.08 KB
 
 ## Dependencies
 
@@ -274,4 +274,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2020 - 2021 Karsten Schmidt // Apache Software License 2.0
+© 2020 - 2022 Karsten Schmidt // Apache Software License 2.0

package/api.d.ts

@@ -61,16 +61,16 @@ export interface IMountWith<T, M> extends IComponent<T> {
      * Component mount lifecycle method which also receives initial
      * state value, presumably meant for populating component.
      *
-     * @param parent
-     * @param index
-     * @param state
+     * @param parent -
+     * @param index -
+     * @param state -
      */
     mount(parent: Element, index: NumOrElement, state: M): Promise<Element>;
     /**
      * Same like {@link IComponent.update}, but new `state` value arg is
      * mandatory.
      *
-     * @param state
+     * @param state -
      */
     update(state: T): void;
 }
@@ -101,15 +101,15 @@ export interface IScheduler {
      * Registers a new task for processing. The `scope` arg is used to uniquely
      * associate the task with a given component.
      *
-     * @param scope
-     * @param task
+     * @param scope -
+     * @param task -
      */
     add(scope: any, task: Task): void;
     /**
      * Attempts to cancel all tasks for given `scope`. Depending on
      * implementation and timing this might not be possible (anymore).
      *
-     * @param scope
+     * @param scope -
      */
     cancel(scope: any): void;
 }

package/compile.d.ts

@@ -18,7 +18,7 @@ import type { IComponent } from "./api.js";
  * will be wrapped using a {@link $sub} `<span>` with the value as its
  * reactive body.
  *
- * @param tree
+ * @param tree -
  */
 export declare const $compile: (tree: any) => IComponent;
 //# sourceMappingURL=compile.d.ts.map

package/compile.js

@@ -25,7 +25,7 @@ import { $wrapText } from "./wrap.js";
  * will be wrapped using a {@link $sub} `<span>` with the value as its
  * reactive body.
  *
- * @param tree
+ * @param tree -
  */
 export const $compile = (tree) => isArray(tree)
     ? isComplexComponent(tree)

package/dom.d.ts

@@ -18,9 +18,9 @@ import type { NumOrElement } from "./api.js";
  * Any other values will be cast to strings and added as spans to
  * current `parent`.
  *
- * @param tree
- * @param parent
- * @param idx
+ * @param tree -
+ * @param parent -
+ * @param idx -
  */
 export declare const $tree: (tree: any, parent: Element, idx?: NumOrElement) => Promise<any>;
 /**
@@ -34,11 +34,11 @@ export declare const $tree: (tree: any, parent: Element, idx?: NumOrElement) =>
  * If `parent` is given, but no `idx` arg, the new element will be
  * appended as child.
  *
- * @param tag
- * @param attribs
- * @param body
- * @param parent
- * @param idx
+ * @param tag -
+ * @param attribs -
+ * @param body -
+ * @param parent -
+ * @param idx -
  */
 export declare const $el: (tag: string, attribs: any, body?: any, parent?: Element | undefined, idx?: NumOrElement) => Element;
 export declare const $addChild: (parent: Element, child: Element, idx?: NumOrElement) => void;
@@ -50,16 +50,16 @@ export declare const $clear: (el: Element) => Element;
  * {@link @thi.ng/api#IDeref} it'll be automatically deref'd. For SVG elements a
  * new child text DOM node will be created.
  *
- * @param el
- * @param body
+ * @param el -
+ * @param body -
  */
 export declare const $text: (el: HTMLElement, body: any) => void;
 /**
  * Same as `el.innerHtml = body`, use with caution! If `body` is an
  * {@link @thi.ng/api#IDeref} it'll be automatically deref'd.
  *
- * @param el
- * @param body
+ * @param el -
+ * @param body -
  */
 export declare const $html: (el: HTMLElement, body: MaybeDeref<string>) => void;
 /**
@@ -91,8 +91,8 @@ export declare const $html: (el: HTMLElement, body: MaybeDeref<string>) => void;
  * Depending on element type the `value` attribute will be updated
  * keeping the current cursor position / selection intact.
  *
- * @param el
- * @param attribs
+ * @param el -
+ * @param attribs -
  */
 export declare const $attribs: (el: Element, attribs: any) => void;
 /**
@@ -106,16 +106,16 @@ export declare const $attribs: (el: Element, attribs: any) => void;
  * function, it will be called with the entire `rules` object as arg and
  * the return value used.
  *
- * @param el
- * @param rules
+ * @param el -
+ * @param rules -
  */
 export declare const $style: (el: Element, rules: string | any) => void;
 /**
  * Registers an XML namespace prefix and its URL for later use, e.g. to
  * define namespaced elements/attributes.
  *
- * @param prefix
- * @param url
+ * @param prefix -
+ * @param url -
  */
 export declare const registerPrefix: (prefix: string, url: string) => void;
 //# sourceMappingURL=dom.d.ts.map

package/dom.js

@@ -30,9 +30,9 @@ import { isComponent } from "./checks.js";
  * Any other values will be cast to strings and added as spans to
  * current `parent`.
  *
- * @param tree
- * @param parent
- * @param idx
+ * @param tree -
+ * @param parent -
+ * @param idx -
  */
 export const $tree = async (tree, parent, idx = -1) => isArray(tree)
     ? $treeElem(tree, parent, idx)
@@ -94,11 +94,11 @@ const $treeIter = (tree, parent) => {
  * If `parent` is given, but no `idx` arg, the new element will be
  * appended as child.
  *
- * @param tag
- * @param attribs
- * @param body
- * @param parent
- * @param idx
+ * @param tag -
+ * @param attribs -
+ * @param body -
+ * @param parent -
+ * @param idx -
  */
 export const $el = (tag, attribs, body, parent, idx = -1) => {
     const match = RE_TAG.exec(tag);
@@ -139,8 +139,8 @@ export const $clear = (el) => ((el.innerHTML = ""), el);
  * {@link @thi.ng/api#IDeref} it'll be automatically deref'd. For SVG elements a
  * new child text DOM node will be created.
  *
- * @param el
- * @param body
+ * @param el -
+ * @param body -
  */
 export const $text = (el, body) => {
     body = String(deref(body));
@@ -155,8 +155,8 @@ export const $text = (el, body) => {
  * Same as `el.innerHtml = body`, use with caution! If `body` is an
  * {@link @thi.ng/api#IDeref} it'll be automatically deref'd.
  *
- * @param el
- * @param body
+ * @param el -
+ * @param body -
  */
 export const $html = (el, body) => {
     el.innerHTML = String(deref(body));
@@ -190,8 +190,8 @@ export const $html = (el, body) => {
  * Depending on element type the `value` attribute will be updated
  * keeping the current cursor position / selection intact.
  *
- * @param el
- * @param attribs
+ * @param el -
+ * @param attribs -
  */
 export const $attribs = (el, attribs) => {
     for (let id in attribs) {
@@ -313,8 +313,8 @@ const updateDataAttribs = (el, attribs) => {
  * function, it will be called with the entire `rules` object as arg and
  * the return value used.
  *
- * @param el
- * @param rules
+ * @param el -
+ * @param rules -
  */
 export const $style = (el, rules) => {
     if (isString(rules)) {
@@ -341,8 +341,8 @@ const PREFIXES = {
  * Registers an XML namespace prefix and its URL for later use, e.g. to
  * define namespaced elements/attributes.
  *
- * @param prefix
- * @param url
+ * @param prefix -
+ * @param url -
  */
 export const registerPrefix = (prefix, url) => {
     assert(!PREFIXES[prefix], `${prefix} already registered: ${PREFIXES[prefix]}`);

package/event.d.ts

@@ -26,28 +26,28 @@ export declare const $inputNum: (stream: ISubscriber<number>, fallback?: number)
 /**
  * HOF DOM event listener to emit a checkbox input's value on given stream.
  *
- * @param stream
+ * @param stream -
  */
 export declare const $inputCheckbox: (stream: ISubscriber<boolean>) => (e: Event) => void;
 /**
  * HOF DOM event listener to emit `true` on given stream when event is
  * triggered.
  *
- * @param stream
+ * @param stream -
  */
 export declare const $inputTrigger: (stream: ISubscriber<boolean>) => () => void;
 /**
  * HOF DOM event listener to emit a file input's first selected file on given
  * stream.
  *
- * @param stream
+ * @param stream -
  */
 export declare const $inputFile: (stream: ISubscriber<File>) => (e: Event) => void;
 /**
  * HOF DOM event listener to emit a file input's entire selected list of files
  * on given stream.
  *
- * @param stream
+ * @param stream -
  */
 export declare const $inputFiles: (stream: ISubscriber<FileList>) => (e: Event) => void;
 //# sourceMappingURL=event.d.ts.map

package/event.js

@@ -26,27 +26,27 @@ export const $inputNum = (stream, fallback = 0) => (e) => stream.next(maybeParse
 /**
  * HOF DOM event listener to emit a checkbox input's value on given stream.
  *
- * @param stream
+ * @param stream -
  */
 export const $inputCheckbox = (stream) => (e) => stream.next(e.target.checked);
 /**
  * HOF DOM event listener to emit `true` on given stream when event is
  * triggered.
  *
- * @param stream
+ * @param stream -
  */
 export const $inputTrigger = (stream) => () => stream.next(true);
 /**
  * HOF DOM event listener to emit a file input's first selected file on given
  * stream.
  *
- * @param stream
+ * @param stream -
  */
 export const $inputFile = (stream) => (e) => stream.next(e.target.files[0]);
 /**
  * HOF DOM event listener to emit a file input's entire selected list of files
  * on given stream.
  *
- * @param stream
+ * @param stream -
  */
 export const $inputFiles = (stream) => (e) => stream.next(e.target.files);

package/klist.d.ts

@@ -36,11 +36,11 @@ interface KListItem {
  * items.next([{id: "b"}, {id: "d"}, {id: "c"}]);
  * ```
  *
- * @param src
- * @param tag
- * @param attribs
- * @param childCtor
- * @param keyFn
+ * @param src -
+ * @param tag -
+ * @param attribs -
+ * @param childCtor -
+ * @param keyFn -
  */
 export declare const $klist: <T>(src: ISubscribable<T[]>, tag: string, attribs: any, childCtor: Fn<T, any>, keyFn?: Fn2<T, number, NumOrString> | undefined) => IComponent<T[]>;
 export declare class KList<T> extends Component<T[]> implements IMountWithState<T[]> {

package/klist.js

@@ -32,11 +32,11 @@ import { $sub } from "./sub.js";
  * items.next([{id: "b"}, {id: "d"}, {id: "c"}]);
  * ```
  *
- * @param src
- * @param tag
- * @param attribs
- * @param childCtor
- * @param keyFn
+ * @param src -
+ * @param tag -
+ * @param attribs -
+ * @param childCtor -
+ * @param keyFn -
  */
 export const $klist = (src, tag, attribs, childCtor, keyFn) => $sub(src, new KList(tag, attribs, childCtor, keyFn));
 export class KList extends Component {

package/list.d.ts

@@ -43,11 +43,11 @@ import { Component } from "./component.js";
  * ```
  *
  *
- * @param src
- * @param tag
- * @param attribs
- * @param ctor
- * @param equiv
+ * @param src -
+ * @param tag -
+ * @param attribs -
+ * @param ctor -
+ * @param equiv -
  */
 export declare const $list: <T>(src: ISubscribable<T[]>, tag: string, attribs: any, ctor: Fn<T, any>, equiv?: Predicate2<T> | undefined) => IComponent<T[]>;
 export declare class List<T> extends Component implements IMountWithState<T[]> {

package/list.js

@@ -42,11 +42,11 @@ import { $sub } from "./sub.js";
  * ```
  *
  *
- * @param src
- * @param tag
- * @param attribs
- * @param ctor
- * @param equiv
+ * @param src -
+ * @param tag -
+ * @param attribs -
+ * @param ctor -
+ * @param equiv -
  */
 export const $list = (src, tag, attribs, ctor, equiv) => $sub(src, new List(tag, attribs, ctor, equiv));
 export class List extends Component {

package/object.d.ts

@@ -37,9 +37,9 @@ import { Component } from "./component.js";
  * obj.update({ id: "b", name: "bar" });
  * ```
  *
- * @param src
+ * @param src -
  * @param opts - options for `fromObject()` stream setup
- * @param inner
+ * @param inner -
  */
 export declare const $object: <T, K extends keyof T>(src: T, opts: Partial<StreamObjOpts<T, K>>, inner: Fn<import("@thi.ng/rstream").KeyStreams<T, K>, Promise<ComponentLike>>) => $Object<T, K>;
 /**
@@ -67,9 +67,9 @@ export declare const $object: <T, K extends keyof T>(src: T, opts: Partial<Strea
  * state.next({ id: "b", name: "bar" });
  * ```
  *
- * @param src
- * @param opts
- * @param inner
+ * @param src -
+ * @param opts -
+ * @param inner -
  */
 export declare const $subObject: <T, K extends keyof T>(src: ISubscribable<T>, opts: Partial<StreamObjOpts<T, K>>, inner: Fn<import("@thi.ng/rstream").KeyStreams<T, K>, Promise<ComponentLike>>) => IComponent<T>;
 export declare class $Object<T, K extends Keys<T>> extends Component implements IMountWithState<T> {

package/object.js

@@ -36,9 +36,9 @@ import { $sub } from "./sub.js";
  * obj.update({ id: "b", name: "bar" });
  * ```
  *
- * @param src
+ * @param src -
  * @param opts - options for `fromObject()` stream setup
- * @param inner
+ * @param inner -
  */
 export const $object = (src, opts, inner) => new $Object(src, opts, inner);
 /**
@@ -66,9 +66,9 @@ export const $object = (src, opts, inner) => new $Object(src, opts, inner);
  * state.next({ id: "b", name: "bar" });
  * ```
  *
- * @param src
- * @param opts
- * @param inner
+ * @param src -
+ * @param opts -
+ * @param inner -
  */
 export const $subObject = (src, opts, inner) => $sub(src, $object(src.deref() || {}, opts, inner));
 export class $Object extends Component {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rdom",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "description": "Lightweight, reactive, VDOM-less UI/DOM components with async lifecycle and @thi.ng/hiccup compatible",
   "type": "module",
   "module": "./index.js",
@@ -35,22 +35,22 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.3",
-    "@thi.ng/checks": "^3.1.3",
-    "@thi.ng/errors": "^2.1.3",
-    "@thi.ng/hiccup": "^4.2.4",
-    "@thi.ng/paths": "^5.1.3",
-    "@thi.ng/prefixes": "^2.1.3",
-    "@thi.ng/rstream": "^7.2.2",
-    "@thi.ng/strings": "^3.3.1"
+    "@thi.ng/api": "^8.3.4",
+    "@thi.ng/checks": "^3.1.4",
+    "@thi.ng/errors": "^2.1.4",
+    "@thi.ng/hiccup": "^4.2.5",
+    "@thi.ng/paths": "^5.1.4",
+    "@thi.ng/prefixes": "^2.1.4",
+    "@thi.ng/rstream": "^7.2.3",
+    "@thi.ng/strings": "^3.3.2"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.2",
-    "@thi.ng/testament": "^0.2.3",
+    "@microsoft/api-extractor": "^7.19.4",
+    "@thi.ng/testament": "^0.2.4",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.10",
-    "typescript": "^4.5.3"
+    "typedoc": "^0.22.13",
+    "typescript": "^4.6.2"
   },
   "keywords": [
     "async",
@@ -140,5 +140,5 @@
     "status": "beta",
     "year": 2020
   },
-  "gitHead": "1ba92c6b9509e74e509b4c0b875fc380a97bbbc1\n"
+  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
 }

package/promise.d.ts

@@ -15,8 +15,8 @@ import { Component } from "./component.js";
  * $promise(prom).mount(document.body);
  * ```
  *
- * @param prom
- * @param error
+ * @param prom -
+ * @param error -
  */
 export declare const $promise: (prom: Promise<ComponentLike>, error?: Fn<Error, any> | undefined) => $Promise;
 export declare class $Promise extends Component {

package/promise.js

@@ -13,8 +13,8 @@ import { Component } from "./component.js";
  * $promise(prom).mount(document.body);
  * ```
  *
- * @param prom
- * @param error
+ * @param prom -
+ * @param error -
  */
 export const $promise = (prom, error) => new $Promise(prom, error);
 export class $Promise extends Component {

package/replace.d.ts

@@ -31,7 +31,7 @@ import { Component } from "./component.js";
  * $compile($replace(counter)).mount(document.body);
  * ```
  *
- * @param src
+ * @param src -
  */
 export declare const $replace: <T>(src: ISubscribable<T>) => IComponent<T>;
 export declare class Replace<T> extends Component implements IMountWithState<T> {

package/replace.js

@@ -32,7 +32,7 @@ import { $wrapText } from "./wrap.js";
  * $compile($replace(counter)).mount(document.body);
  * ```
  *
- * @param src
+ * @param src -
  */
 export const $replace = (src) => $sub(src, new Replace());
 export class Replace extends Component {

package/scheduler.d.ts

@@ -30,8 +30,7 @@ export declare let SCHEDULER: IScheduler;
 /**
  * Sets rdom-global scheduler for component updates (and other tasks).
  *
- * @param s
- * @returns
+ * @param s -
  */
 export declare const setScheduler: (s: IScheduler) => IScheduler;
 //# sourceMappingURL=scheduler.d.ts.map

package/scheduler.js

@@ -47,7 +47,6 @@ export let SCHEDULER = new NullScheduler();
 /**
  * Sets rdom-global scheduler for component updates (and other tasks).
  *
- * @param s
- * @returns
+ * @param s -
  */
 export const setScheduler = (s) => (SCHEDULER = s);

package/sub.d.ts

@@ -22,8 +22,8 @@ import type { IComponent, IMountWithState, NumOrElement } from "./api.js";
  * src.next(43);
  * ```
  *
- * @param src
- * @param inner
+ * @param src -
+ * @param inner -
  */
 export declare function $sub<T>(src: ISubscribable<T>, inner: IMountWithState<T>): IComponent<T>;
 export declare function $sub(src: ISubscribable<any>, tag: string, attribs?: any): IComponent;

package/switch.d.ts

@@ -48,11 +48,11 @@ import { Component } from "./component.js";
  * components, however only two are defined, causing the last option to
  * throw an error and so trigger/use the error component.
  *
- * @param src
- * @param keyFn
- * @param ctors
- * @param error
- * @param loader
+ * @param src -
+ * @param keyFn -
+ * @param ctors -
+ * @param error -
+ * @param loader -
  */
 export declare const $switch: <T>(src: ISubscribable<T>, keyFn: Fn<T, NumOrString>, ctors: Record<NumOrString, Fn<T, Promise<any>>>, error?: Fn<Error, Promise<any>> | undefined, loader?: Fn<T, Promise<any>> | undefined) => IComponent<T>;
 /**
@@ -72,10 +72,10 @@ export declare const $switch: <T>(src: ISubscribable<T>, keyFn: Fn<T, NumOrStrin
  * $refresh(fromInterval(1000), async (x) => ["div", {}, x])
  * ```
  *
- * @param src
- * @param ctor
- * @param error
- * @param loader
+ * @param src -
+ * @param ctor -
+ * @param error -
+ * @param loader -
  */
 export declare const $refresh: <T>(src: ISubscribable<T>, ctor: Fn<T, Promise<any>>, error?: Fn<Error, Promise<any>> | undefined, loader?: Fn<T, Promise<any>> | undefined) => IComponent<T>;
 export declare class Switch<T> extends Component implements IMountWithState<T> {

package/switch.js

@@ -49,11 +49,11 @@ import { $wrapText } from "./wrap.js";
  * components, however only two are defined, causing the last option to
  * throw an error and so trigger/use the error component.
  *
- * @param src
- * @param keyFn
- * @param ctors
- * @param error
- * @param loader
+ * @param src -
+ * @param keyFn -
+ * @param ctors -
+ * @param error -
+ * @param loader -
  */
 export const $switch = (src, keyFn, ctors, error, loader) => $sub(src, new Switch(keyFn, ctors, error, loader));
 /**
@@ -73,10 +73,10 @@ export const $switch = (src, keyFn, ctors, error, loader) => $sub(src, new Switc
  * $refresh(fromInterval(1000), async (x) => ["div", {}, x])
  * ```
  *
- * @param src
- * @param ctor
- * @param error
- * @param loader
+ * @param src -
+ * @param ctor -
+ * @param error -
+ * @param loader -
  */
 export const $refresh = (src, ctor, error, loader) => $switch(src, () => 0, { 0: ctor }, error, loader);
 export class Switch extends Component {