react-deepwatch 1.0.0

package/dist/mjs/Util.js

@@ -0,0 +1,164 @@
+export function throwError(e) {
+    if (e !== null && e instanceof Error) {
+        throw e;
+    }
+    throw new Error(e);
+}
+export function reThrowWithHint(e, hint) {
+    try {
+        if (e instanceof Error) {
+            // Add hint to error:
+            e.message += `\n${hint}`;
+        }
+    }
+    catch (x) {
+    }
+    throw e;
+}
+export function isObject(value) {
+    return value !== null && typeof value === "object";
+}
+/**
+ * A Map<K, Set<V>>. But automatically add a new Set if needed
+ */
+export class MapSet {
+    constructor() {
+        this.map = new Map();
+    }
+    add(key, value) {
+        let set = this.map.get(key);
+        if (set === undefined) {
+            set = new Set();
+            this.map.set(key, set);
+        }
+        set.add(value);
+    }
+    delete(key, value) {
+        let set = this.map.get(key);
+        if (set !== undefined) {
+            set.delete(value);
+            if (set.size === 0) {
+                this.map.delete(key); // Clean up
+            }
+        }
+    }
+    get(key) {
+        return this.map.get(key);
+    }
+}
+/**
+ * A WeakMap<K, Set<V>>. But automatically add a new Set if needed
+ */
+export class WeakMapSet extends MapSet {
+    constructor() {
+        super(...arguments);
+        //@ts-ignore
+        this.map = new WeakMap();
+    }
+}
+export function arraysAreEqualsByPredicateFn(a, b, equalsFn) {
+    if (a.length !== b.length) {
+        return false;
+    }
+    for (const k in a) {
+        if (!equalsFn(a[k], b[k])) {
+            return false;
+        }
+    }
+    return true;
+}
+function diagnosis_jsonPath(key) {
+    if (!Number.isNaN(Number(key))) {
+        return `[${key}]`;
+    }
+    return `.${key}`;
+}
+/**
+ * Usage:
+ *  <pre><code>
+ *  const result = visitReplace(target, (value, visitChilds, context) => {
+ *      return value === 'needle' ? 'replaced' : visitChilds(value, context)
+ *  });
+ *  </code></pre>
+ *
+ * @param value
+ * @param visitor
+ * @param trackPath whether to pass on the context object. This hurts performance because the path is concatted every time, so use it only when needed. Setting this to "onError" re-executes the visitprelace with the concetxt when an error was thrown
+ */
+export function visitReplace(value, visitor, trackPath = false) {
+    const visisitedObjects = new Set();
+    function visitChilds(value, context) {
+        if (value === null) {
+            return value;
+        }
+        else if (typeof value === "object") {
+            const obj = value;
+            if (visisitedObjects.has(obj)) {
+                return value; // don't iterate again
+            }
+            visisitedObjects.add(obj);
+            for (let k in obj) {
+                const keyInParent = k;
+                const childValue = obj[keyInParent];
+                let newValue = visitor(childValue, visitChilds, Object.assign(Object.assign({}, context), { parentObject: value, key: keyInParent, diagnosis_path: (context.diagnosis_path !== undefined ? `${context.diagnosis_path}${diagnosis_jsonPath(keyInParent)}` : undefined) }));
+                if (newValue !== childValue) { // Only if childValue really has changed. We don't want to interfer with setting a readonly property and trigger a proxy
+                    // @ts-ignore
+                    obj[keyInParent] = newValue;
+                }
+            }
+        }
+        return value;
+    }
+    if (trackPath === "onError") {
+        try {
+            return visitor(value, visitChilds, {}); // Fast try without context
+        }
+        catch (e) {
+            return visitReplace(value, visitor, true); // Try again with context
+        }
+    }
+    return visitor(value, visitChilds, { diagnosis_path: trackPath ? "" : undefined });
+}
+/**
+ * Just do something the runtime can't optimize away
+ * @param value
+ */
+export function read(value) {
+    if (("" + value) == "blaaxyxzzzsdf") {
+        throw new Error("should never get here");
+    }
+}
+export function arraysAreShallowlyEqual(a, b) {
+    if (a.length !== b.length) {
+        return false;
+    }
+    for (let i = 0; i < a.length; i++) {
+        if (a[i] !== b[i]) { // TODO add option for object instance equality
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Like arraysAreShallowlyEqual but this time for an array of entries (tuple of 2 values) like from Map#entries()
+ * @param a
+ * @param b
+ */
+export function arraysWithEntriesAreShallowlyEqual(a, b) {
+    if (a.length !== b.length) {
+        return false;
+    }
+    for (let i = 0; i < a.length; i++) {
+        if (a[i][0] !== b[i][0]) { // TODO add option for object instance equality
+            return false;
+        }
+        if (a[i][1] !== b[i][1]) { // TODO add option for object instance equality
+            return false;
+        }
+    }
+    return true;
+}
+export function recordedReadsArraysAreEqual(a, b) {
+    return arraysAreEqualsByPredicateFn(a, b, (a, b) => a.equals(b));
+}
+//# sourceMappingURL=Util.js.map

package/dist/mjs/Util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Util.js","sourceRoot":"","sources":["../../Util.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,UAAU,CAAC,CAAiB;IACxC,IAAG,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;QAClC,MAAM,CAAC,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,CAAU,EAAE,IAAY;IACpD,IAAI,CAAC;QACD,IAAG,CAAC,YAAY,KAAK,EAAE,CAAC;YACpB,qBAAqB;YACrB,CAAC,CAAC,OAAO,IAAG,KAAK,IAAI,EAAE,CAAC;QAC5B,CAAC;IACL,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;IACX,CAAC;IACD,MAAM,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACnC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,MAAM;IAAnB;QACI,QAAG,GAAG,IAAI,GAAG,EAAa,CAAA;IAwB9B,CAAC;IAtBG,GAAG,CAAC,GAAM,EAAE,KAAQ;QAChB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAG,GAAG,KAAK,SAAS,EAAE,CAAC;YACnB,GAAG,GAAG,IAAI,GAAG,EAAK,CAAC;YACnB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAED,MAAM,CAAC,GAAM,EAAE,KAAQ;QACnB,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAG,GAAG,KAAK,SAAS,EAAE,CAAC;YACnB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAClB,IAAG,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBAChB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW;YACrC,CAAC;QACL,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAM;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,OAAO,UAAiB,SAAQ,MAAY;IAAlD;;QACI,YAAY;QACZ,QAAG,GAAG,IAAI,OAAO,EAAa,CAAC;IACnC,CAAC;CAAA;AAED,MAAM,UAAU,4BAA4B,CAAO,CAAM,EAAE,CAAM,EAAE,QAAgC;IAC/F,IAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,KAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACf,IAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAcD,SAAS,kBAAkB,CAAC,GAAY;IACpC,IAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,GAAG,GAAG,CAAC;IACtB,CAAC;IACD,OAAO,IAAI,GAAG,EAAE,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAAI,KAAQ,EAAE,OAA0I,EAAG,YAAiC,KAAK;IACzN,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAA;IAE1C,SAAS,WAAW,CAAC,KAAc,EAAE,OAA4B;QAC7D,IAAG,KAAK,KAAK,IAAI,EAAE,CAAC;YAChB,OAAO,KAAK,CAAC;QACjB,CAAC;aACI,IAAG,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,KAAe,CAAC;YAC5B,IAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC,CAAC,sBAAsB;YACxC,CAAC;YACD,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAE1B,KAAK,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;gBAChB,MAAM,WAAW,GAAG,CAAiB,CAAC;gBACtC,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC;gBACpC,IAAI,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,kCAAM,OAAO,KAAE,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,OAAO,CAAC,cAAc,KAAK,SAAS,CAAA,CAAC,CAAA,GAAG,OAAO,CAAC,cAAe,GAAG,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAA,CAAC,CAAA,SAAS,CAAC,IAAE,CAAC;gBACtO,IAAG,QAAQ,KAAK,UAAU,EAAE,CAAC,CAAC,wHAAwH;oBAClJ,aAAa;oBACb,GAAG,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;gBAChC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAG,SAAS,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC;YACD,OAAO,OAAO,CAAC,KAAK,EAAG,WAAW,EAAE,EAAE,CAAM,CAAC,CAAC,2BAA2B;QAC7E,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YACP,OAAO,YAAY,CAAC,KAAK,EAAG,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,yBAAyB;QACzE,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC,KAAK,EAAE,WAAW,EAAC,EAAC,cAAc,EAAE,SAAS,CAAA,CAAC,CAAA,EAAE,CAAA,CAAC,CAAA,SAAS,EAAC,CAAM,CAAC;AACrF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,IAAI,CAAC,KAAU;IAC3B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,IAAI,eAAe,EAAG,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;IAC5C,CAAC;AACL,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,CAAY,EAAE,CAAY;IAC9D,IAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,KAAI,IAAI,CAAC,GAAG,CAAC,EAAC,CAAC,GAAC,CAAC,CAAC,MAAM,EAAC,CAAC,EAAE,EAAE,CAAC;QAC3B,IAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,+CAA+C;YAC/D,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kCAAkC,CAAC,CAA4B,EAAE,CAA4B;IACzG,IAAG,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,KAAI,IAAI,CAAC,GAAG,CAAC,EAAC,CAAC,GAAC,CAAC,CAAC,MAAM,EAAC,CAAC,EAAE,EAAE,CAAC;QAC3B,IAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,+CAA+C;YACrE,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,IAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,+CAA+C;YACrE,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,CAAiB,EAAE,CAAiB;IAC5E,OAAO,4BAA4B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AACrE,CAAC"}

package/dist/mjs/index.d.ts

@@ -0,0 +1,218 @@
+import { ReactNode } from "react";
+import { PreserveOptions } from "./preserve";
+type WatchedComponentOptions = {
+    /**
+     * A fallback react tree to show when some `load(...)` statement in <strong>this</strong> component is loading.
+     * Use this if you have issues with screen flickering with <code><Suspense></code>.
+     */
+    fallback?: ReactNode;
+    /**
+     * Wraps this component in a {@link https://react.dev/reference/react/memo memo} to prevent unnecessary re-renders.
+     * This is enabled by default, since watchedComponents smartly tracks deep changes of used props and knows when to rerender.
+     * Disable this only in a mixed scenario with non-watchedComponents, where they rely on the old way of fully re-rendering the whole tree to pass deep model data (=more than using shallow, primitive props) to the leaves. So this component does not block these re-renders in the middle.
+     * <p>
+     *   Default: true
+     * </p>
+     */
+    memo?: boolean;
+    /**
+     * TODO
+     * Normally, everything that's **taken** from props, {@link useWatchedState} or {@link watched} or load(...)'s result will be returned, wrapped in a proxy that watches for modifications.
+     * So far, so good, this can handle all stuff that's happening inside your component, but the outside world does not have these proxies. For example, when a parent component is not a watchedComponent, and passed in an object (i.e. the model) into this component via props.
+     * Therefore this component can also **patch** these objects to make them watchable.
+     *
+     *
+     * <p>Default: true</p>
+     */
+    watchOutside?: boolean;
+    /**
+     * TODO: implement
+     * Preserves object instances in props by running the {@link preserve} function over the props (where the last value is memoized).
+     * <p>
+     * It's not recommended to enable this. Use only as a workaround when working with non-watched components where you have no control over. Better run {@link preserve} on the fetched source and keep a consistent-instance model in your app in the first place.
+     * </p>
+     *
+     * Note: Even with false, the `props` root object still keeps its instance (so it's save to watch `props.myFirstLevelProperty`).
+     * <p>
+     *     Default: false
+     * </p>
+     */
+    preserveProps?: boolean;
+};
+export declare function watchedComponent<PROPS extends object>(componentFn: (props: PROPS) => any, options?: WatchedComponentOptions): ((props: PROPS) => any) | import("react").MemoExoticComponent<(props: PROPS) => any>;
+type WatchedOptions = {
+    /**
+     * TODO: Implement
+     * Called, when a deep property was changed through the proxy.
+     */
+    onChange?: () => void;
+    /**
+     * TODO: Implement
+     * Called on a change to one of those properties, that were read-recorded in the component function (through the proxy of course).
+     * Reacts also on external changes / not done through the proxy.
+     */
+    onRecordedChange?: () => void;
+};
+export declare function useWatchedState(initial: object, options?: WatchedOptions): object;
+type LoadOptions = {
+    /**
+     * For {@link LoadOptions#preserve preserving} the result's object identity.
+     * Normally, this is obtained from the call stack information plus the {@link LoadOptions#key}.
+     *
+     * @see LoadOptions#key
+     */
+    id?: string | number | object;
+    /**
+     * Helps identifying the load(...) call from inside a loop for {@link LoadOptions#preserve preserving} the result's object identity.
+     * @see LoadOptions#id
+     */
+    key?: string | number;
+    /**
+     * If you specify a fallback, the component can be immediately rendered during loading.
+     * <p>
+     * undefined = undefined as fallback.
+     * </p>
+     */
+    fallback?: unknown;
+    /**
+     * Performance: Will return the old value from a previous load, while this is still loading. This causes less disturbance (i.e. triggering dependent loads) while switching back to the fallback and then to a real value again.
+     * <p>Best used in combination with {@link isLoading} and {@link fallback}</p>
+     * <p>Default: false</p>
+     */
+    silent?: boolean;
+    /**
+     * Performance: Set to false, to mark following `load(...)` statements do not depend on the result. I.e when used only for immediate rendering or passed to child components only. I.e. <div>{load(...)}/div> or `<MySubComponent param={load(...)} />`:
+     * Therefore, the following `load(...)` statements may not need a reload and can run in parallel.
+     * <p>
+     *     Default: true
+     *  </p>
+     */
+    critical?: boolean;
+    /**
+     * Poll after this amount of milliseconds
+     */
+    poll?: number;
+    /**
+     * {@link isLoading} Can filter for only the load(...) statements with this given name.
+     */
+    name?: string;
+    /**
+     *
+     * <p>Default: true</p>
+     */
+    preserve?: boolean | PreserveOptions;
+};
+type PollOptions = {
+    /**
+     * Interval in milliseconds
+     */
+    interval: number;
+    /**
+     * - true = interval means loaderFn-start to loaderFn-start
+     * - false = interval means loaderFn-end to loaderFn-start (the longer loaderFn takes, the more time till next re-poll)
+     * <p>
+     * Default: true
+     * </p>
+     */
+    fixedInterval?: boolean;
+};
+/**
+ * Runs the async loaderFn and re-renders, if its promise was resolved. Also re-renders and re-runs loaderFn, when some of its watched dependencies, used prior or instantly in the loaderFn, change.
+ * Puts the component into suspense while loading. Throws an error when loaderFn throws an error or its promise is rejected. Resumes from react-error-boundary automatically when loaderFn was re-run(because of the above).
+ * <p>
+ * {@link https://github.com/bogeeee/react-deepwatch#and-less-loading-code Usage}.
+ * </p>
+ * @param loaderFn
+ * @param options
+ */
+export declare function load<T, FALLBACK>(loaderFn: (oldResult?: T) => Promise<T>, options?: Omit<LoadOptions, "fallback">): T;
+/**
+ * Runs the async loaderFn and re-renders, if its promise was resolved. Also re-renders and re-runs loaderFn, when some of its watched dependencies, used prior or instantly in the loaderFn, change.
+ * Puts the component into suspense while loading. Throws an error when loaderFn throws an error or its promise is rejected. Resumes from react-error-boundary automatically when loaderFn was re-run(because of the above).
+ * <p>
+ * {@link https://github.com/bogeeee/react-deepwatch#and-less-loading-code Usage}.
+ * </p>
+ * @param loaderFn
+ * @param options
+ */
+export declare function load<T, FALLBACK>(loaderFn: (oldResult?: T) => Promise<T>, options: LoadOptions & {
+    fallback: FALLBACK;
+}): T | FALLBACK;
+/**
+ * Probe if a <code>load(...)</code> statement directly inside this watchedComponent is currently loading.
+ * Note: It's mostly needed to also specify a {@link LoadOptions#fallback} in the load statement's options to produce a valid render result while loading. Otherwise the whole component goes into suspense.
+ * <p>
+ * Example. This uses isLoading() to determine if the Dropdown list should be faded/transparent during while items are loading:
+ * <pre><code>
+ *     return  <select style={{opacity: isLoading("dropdownItems")?0.5:1}}>
+ *                 {load(() => fetchMyDropdownItems(), {name: "dropdownItems", fallback: ["loading items"]}).map(i => <option value="{i}">{i}</option>)}
+ *     </select>
+ * </code></pre>
+ * </p>
+ * <p>
+ * Caveat: You must not use this for a condition that cuts away a load(...) statement in the middle of your render code. This is because an extra render run is issued for isLoading() and the load(...) statements are re-matched by their order.
+ * </p>
+ * @param nameFilter When set, consider only those with the given {@link LoadOptions#name}. I.e. <code>load(..., {name: "myDropdownListEntries"})</code>
+ *
+ */
+export declare function isLoading(nameFilter?: string): boolean;
+/**
+ * Probe if a <code>load(...)</code> statement directly inside this watchedComponent failed.
+ * <p>
+ * Example:
+ * <pre><code>
+ *     if(loadFailed()) {
+ *          return <div>Load failed: {loadFailed().message}</div>;
+ *     }
+ *
+ *     return <div>My component content {load(...)} </div>
+ * </code></pre>
+ * </p>
+ * <p>
+ * Caveat: You must not use this for a condition that cuts away a load(...) statement in the middle of your render code. This is because an extra render run is issued for loadFailed() and the load(...) statements are re-matched by their order.
+ * </p>
+ * @param nameFilter When set, consider only those with the given {@link LoadOptions#name}. I.e. <code>load(..., {name: "myDropdownListEntries"})</code>
+ * @returns unknown The thrown value of the loaderFn or undefined if everything is ok.
+ */
+export declare function loadFailed(nameFilter?: string): unknown;
+/**
+ * Like {@link load}, but re-runs loaderFn regularly at the interval, specified in the options.
+ * <p>
+ * Example: <code>return <div>The current outside temperature is {  poll( async () => await fetchTemperatureFromServer(), {interval: 1000} )  }° </div></code> *
+ * </p>
+ * <p>
+ * Polling is still continued in recoverable error cases, when
+ * </p>
+ *  - loaderFn fails but your watchedComponent catches it and returns fine.
+ *  - Your watchedComponent returns with an error(because of this loaderFn or some other reason) and it is wrapped in a react-error-boundary.
+ *
+ * <p>
+ *     Note, that after the initial load, re-polling is done <strong>very silently</strong>. Meaning, there's no suspense / fallback / isLoading indicator involved.
+ * </p>
+ * @param loaderFn
+ * @param options
+ */
+export declare function poll<T, FALLBACK>(loaderFn: (oldResult?: T) => Promise<T>, options: Omit<LoadOptions, "fallback"> & PollOptions): T;
+/**
+ * Like {@link load}, but re-runs loaderFn regularly at the interval, specified in the options.
+ * <p>
+ * Example: <code>return <div>The current outside temperature is {  async poll( await () => fetchTemperatureFromServer(), {interval: 1000} )  }° </div></code> *
+ * </p>
+ * <p>
+ * Polling is still continued in recoverable error cases, when
+ * </p>
+ *  - loaderFn fails but your watchedComponent catches it and returns fine.
+ *  - Your watchedComponent returns with an error(because of this loaderFn or some other reason) and it is wrapped in a react-error-boundary.
+ *
+ * <p>
+ *     Note, that after the initial load, re-polling is done <strong>very silently</strong>. Meaning, there's no suspense / fallback / isLoading indicator involved.
+ * </p>
+ * @param loaderFn
+ * @param options
+ */
+export declare function poll<T, FALLBACK>(loaderFn: (oldResult?: T) => Promise<T>, options: LoadOptions & {
+    fallback: FALLBACK;
+} & PollOptions): T | FALLBACK;
+export declare function debug_tagComponent(name: string): void;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/mjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAqD,SAAS,EAA8B,MAAM,OAAO,CAAC;AAEjH,OAAO,EAAsB,eAAe,EAAC,MAAM,YAAY,CAAC;AAShE,KAAK,uBAAuB,GAAG;IAC3B;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AA+hBD,wBAAgB,gBAAgB,CAAC,KAAK,SAAS,MAAM,EAAE,WAAW,EAAC,CAAC,KAAK,EAAE,KAAK,KAAK,GAAG,EAAE,OAAO,GAAE,uBAA4B,YAC/F,KAAK,wDAAL,KAAK,UA2GpC;AAED,KAAK,cAAc,GAAG;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IAErB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAA;CAChC,CAAA;AAOD,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,UAKxE;AAgBD,KAAK,WAAW,GAAG;IACf;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAE7B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAErB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAWlB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,eAAe,CAAA;CACvC,CAAA;AACD,KAAK,WAAW,GAAG;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;;;;OAMG;IACH,aAAa,CAAC,EAAC,OAAO,CAAA;CACzB,CAAA;AAED;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,CAAC,CAAA;AACrH;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,GAAG;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAC,GAAG,CAAC,GAAG,QAAQ,CAAA;AAwPpI;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAMtD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAQvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,WAAW,GAAG,CAAC,CAAA;AAClI;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,GAAG;IAAC,QAAQ,EAAE,QAAQ,CAAA;CAAC,GAAG,WAAW,GAAG,CAAC,GAAG,QAAQ,CAAA;AA8ClJ,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,QAE9C"}