@dereekb/rxjs 13.4.0 → 13.4.2

package/index.esm.js

@@ -1,5 +1,5 @@
 import { isObservable, of, switchMap, combineLatest, map, delay, startWith, filter, skipWhile, EMPTY, distinctUntilChanged, mergeMap, BehaviorSubject, shareReplay, skip, defaultIfEmpty, first, finalize, merge, firstValueFrom, exhaustMap, scan, identity, throttleTime, takeWhile, timeout, tap, throwError, timer, delayWhen, asyncScheduler, from, catchError, Subject } from 'rxjs';
-import { getValueFromGetter, isMaybeSo, filterMaybeArrayValues, areEqualPOJOValues, convertToArray, asGetter, performTaskLoop, isMaybeNot, forEachWithArray, pushArrayItemsIntoArray, pushItemOrArrayItemsIntoArray, asArray, filterAndMapFunction, expirationDetails, objectKeysEqualityComparatorFunction, objectKeyEqualityComparatorFunction, asPromise, randomNumberFactory, mapsHaveSameKeys, mapKeysIntersectionObjectToArray, incrementingNumberFactory, filterUniqueFunction, build, cachedGetter, allKeyValueTuples, keyValueMapFactory, multiKeyValueMapFactory, timePeriodCounter, hasSameValues, compareEqualityWithValueFromItemsFunction, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, searchStringFilterFunction, reduceBooleansWithAnd, toReadableError, reduceBooleansWithOr, valuesAreBothNullishOrEquivalent, mergeObjects, objectHasKey, safeCompareEquality, hasNonNullValue, limitArray, mapFunctionOutputPair, lastValue, flattenArray, hasValueOrNotEmpty, filteredPage, invertMaybeBoolean, FIRST_PAGE, getNextPageNumber, reduceBooleansWithOrFn, MS_IN_SECOND } from '@dereekb/util';
+import { getValueFromGetter, isMaybeSo, filterMaybeArrayValues, areEqualPOJOValues, convertToArray, asGetter, performTaskLoop, isMaybeNot, forEachWithArray, pushArrayItemsIntoArray, asArray, pushItemOrArrayItemsIntoArray, filterAndMapFunction, expirationDetails, objectKeysEqualityComparatorFunction, objectKeyEqualityComparatorFunction, asPromise, randomNumberFactory, mapsHaveSameKeys, mapKeysIntersectionObjectToArray, incrementingNumberFactory, filterUniqueFunction, build, cachedGetter, allKeyValueTuples, keyValueMapFactory, multiKeyValueMapFactory, timePeriodCounter, hasSameValues, compareEqualityWithValueFromItemsFunction, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, searchStringFilterFunction, reduceBooleansWithAnd, toReadableError, reduceBooleansWithOr, valuesAreBothNullishOrEquivalent, mergeObjects, objectHasKey, safeCompareEquality, hasNonNullValue, limitArray, mapFunctionOutputPair, lastValue, flattenArray, hasValueOrNotEmpty, filteredPage, invertMaybeBoolean, FIRST_PAGE, getNextPageNumber, reduceBooleansWithOrFn, MS_IN_SECOND } from '@dereekb/util';
 
 function asObservable(valueOrObs) {
     if (isObservable(valueOrObs)) {
@@ -43,6 +43,8 @@ function asObservableFromGetter(input, args) {
 /**
  * RxJS operator that flattens an emitted Maybe<{@link ObservableOrValueGetter}> into its resolved value,
  * emitting `undefined` when the input is nullish.
+ *
+ * @returns an operator that unwraps Maybe<ObservableOrValueGetter> emissions, emitting undefined for nullish inputs
  */ function maybeValueFromObservableOrValueGetter() {
     return switchMap(function(x) {
         return x != null ? asObservableFromGetter(x) : of(undefined);
@@ -137,6 +139,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  *
  * @param isCheckFunction - optional check function
  * @param defaultValueOnMaybe - default result for null/undefined values
+ * @returns a function that evaluates each value against the check function and returns it or undefined
  */ function makeReturnIfIsFunction(isCheckFunction, defaultValueOnMaybe) {
     return function(value) {
         return returnIfIs(isCheckFunction, value, defaultValueOnMaybe);
@@ -148,6 +151,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  * @param isCheckFunction - optional check function
  * @param value - the value to check
  * @param defaultValueOnMaybe - default result for null/undefined values
+ * @returns an observable that emits the value if the check passes, or undefined otherwise
  */ function returnIfIs(isCheckFunction, value, defaultValueOnMaybe) {
     return checkIs(isCheckFunction, value, defaultValueOnMaybe).pipe(map(function(x) {
         return x ? value : undefined;
@@ -158,6 +162,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  *
  * @param isCheckFunction - optional check function
  * @param defaultValueOnMaybe - default result for null/undefined values
+ * @returns a function that evaluates each value against the check function and returns an observable boolean
  */ function makeCheckIsFunction(isCheckFunction, defaultValueOnMaybe) {
     return function(value) {
         return checkIs(isCheckFunction, value, defaultValueOnMaybe);
@@ -171,6 +176,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  * @param isCheckFunction - optional check function
  * @param value - the value to check
  * @param defaultValueOnMaybe - default result for null/undefined values (defaults to false)
+ * @returns an observable boolean indicating whether the value passes the check
  */ function checkIs(isCheckFunction, value) {
     var defaultValueOnMaybe = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : false;
     var is = isCheckFunction ? value != null ? isCheckFunction(value) : of(defaultValueOnMaybe) : of(true);
@@ -179,6 +185,8 @@ function _unsupported_iterable_to_array$b(o, minLen) {
 // MARK: Filter
 /**
  * RxJS operator that filters out null and undefined values, only passing through defined values.
+ *
+ * @returns operator that filters out null and undefined emissions
  */ function filterMaybe() {
     return filter(isMaybeSo);
 }
@@ -187,11 +195,15 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  */ var filterMaybeStrict = filterMaybe;
 /**
  * RxJS operator that filters out null/undefined elements from an emitted array, keeping only defined values.
+ *
+ * @returns operator that maps each emitted array to a version with null/undefined elements removed
  */ function filterMaybeArray() {
     return map(filterMaybeArrayValues);
 }
 /**
  * RxJS operator that skips all leading null/undefined emissions, then passes all subsequent values through.
+ *
+ * @returns operator that skips all null/undefined emissions at the start of the stream
  */ function skipAllInitialMaybe() {
     return skipWhile(function(x) {
         return x == null;
@@ -199,6 +211,8 @@ function _unsupported_iterable_to_array$b(o, minLen) {
 }
 /**
  * RxJS operator that skips only the first emission if it is null/undefined, then passes all subsequent values.
+ *
+ * @returns operator that skips the first null/undefined emission if it occurs at the start of the stream
  */ function skipInitialMaybe() {
     return skipMaybes(1);
 }
@@ -206,6 +220,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
  * RxJS operator that skips up to `maxToSkip` null/undefined emissions, then passes all subsequent values.
  *
  * @param maxToSkip - maximum number of null/undefined emissions to skip
+ * @returns operator that skips the first N null/undefined emissions from the stream
  */ function skipMaybes(maxToSkip) {
     return skipWhile(function(x, i) {
         return x == null && i < maxToSkip;
@@ -227,7 +242,7 @@ function _unsupported_iterable_to_array$b(o, minLen) {
     });
 }
 function switchMapToDefault(defaultObs, useDefault) {
-    var useDefaultFn = useDefault ? useDefault : function(x) {
+    var useDefaultFn = useDefault !== null && useDefault !== void 0 ? useDefault : function(x) {
         return of(x == null);
     };
     return switchMap(function(x) {
@@ -243,6 +258,9 @@ function switchMapToDefault(defaultObs, useDefault) {
 /**
  * RxJS operator that resolves an observable/getter config input into a value, applying defaults
  * for `null`/`undefined`/`true` inputs and emitting `null` for `false`.
+ *
+ * @param config - configuration providing an optional default getter for null/undefined/true inputs
+ * @returns operator that resolves each emitted getter into a value, using the default for nullish or true inputs
  */ function switchMapObject(config) {
     var defaultGetter = config.defaultGetter;
     return switchMap(function(inputConfig) {
@@ -277,6 +295,8 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
  * RxJS operator that filters out null/undefined observables and then switches to the remaining ones.
  *
  * Combines {@link filterMaybe} and `switchMap` to only subscribe to non-nullish observables.
+ *
+ * @returns operator that filters nullish observables and subscribes to the non-nullish ones
  */ function switchMapFilterMaybe() {
     return function(source) {
         var subscriber = source.pipe(filterMaybe(), switchMap(function(x) {
@@ -287,10 +307,12 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
 }
 /**
  * RxJS operator that switches to the emitted observable if defined, or emits `undefined` when the observable is nullish.
+ *
+ * @returns operator that switches to the emitted observable or emits undefined for null/undefined inputs
  */ function switchMapMaybe() {
     return function(source) {
         var subscriber = source.pipe(switchMap(function(x) {
-            return x != null ? x : of(undefined);
+            return x !== null && x !== void 0 ? x : of(undefined);
         }));
         return subscriber;
     };
@@ -315,11 +337,11 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
     });
 }
 /**
- * Combines both combineLatest with map values to an other value.
+ * Combines the source observable with another observable via `combineLatest`, then maps the pair to a result.
  *
- * @param combineObs
- * @param mapFn
- * @returns
+ * @param combineObs - the secondary observable to combine with the source
+ * @param mapFn - function that maps the source value and combined value to the output
+ * @returns operator that combines the source with `combineObs` and maps each pair using `mapFn`
  */ function combineLatestMapFrom(combineObs, mapFn) {
     return function(obs) {
         return combineLatest([
@@ -335,6 +357,11 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
  * Creates an observable that emits a starting value, then a second value after a delay.
  *
  * If the delay is not provided, or is falsy, then the second value is never emitted.
+ *
+ * @param startWith - the value to emit immediately
+ * @param endWith - the value to emit after the delay
+ * @param delayTime - optional delay in milliseconds before emitting the second value
+ * @returns an observable that emits `startWith` immediately and `endWith` after the delay (if provided)
  */ function emitDelayObs(startWith, endWith, delayTime) {
     var obs = of(startWith);
     if (delayTime) {
@@ -344,6 +371,10 @@ function switchMapOnBoolean(switchOnValue, obs, otherwise) {
 }
 /**
  * Emits a value after a given delay after every new emission.
+ *
+ * @param value - the value to emit after the delay
+ * @param delayTime - duration in milliseconds before emitting the value
+ * @returns operator that appends the given value after each source emission with the specified delay
  */ function emitAfterDelay(value, delayTime) {
     return function(obs) {
         return obs.pipe(switchMap(function(x) {
@@ -386,7 +417,7 @@ function _array_like_to_array$a(arr, len) {
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
     return arr2;
 }
-function _array_without_holes$5(arr) {
+function _array_without_holes$6(arr) {
     if (Array.isArray(arr)) return _array_like_to_array$a(arr);
 }
 function _class_call_check$8(instance, Constructor) {
@@ -420,14 +451,14 @@ function _define_property$c(obj, key, value) {
     }
     return obj;
 }
-function _iterable_to_array$5(iter) {
+function _iterable_to_array$6(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
-function _non_iterable_spread$5() {
+function _non_iterable_spread$6() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-function _to_consumable_array$5(arr) {
-    return _array_without_holes$5(arr) || _iterable_to_array$5(arr) || _unsupported_iterable_to_array$a(arr) || _non_iterable_spread$5();
+function _to_consumable_array$6(arr) {
+    return _array_without_holes$6(arr) || _iterable_to_array$6(arr) || _unsupported_iterable_to_array$a(arr) || _non_iterable_spread$6();
 }
 function _unsupported_iterable_to_array$a(o, minLen) {
     if (!o) return;
@@ -467,6 +498,8 @@ function _unsupported_iterable_to_array$a(o, minLen) {
             key: "hasSubscription",
             get: /**
      * Whether a subscription is currently being managed.
+     *
+     * @returns true if a subscription is currently active
      */ function get() {
                 return Boolean(this._subscription);
             }
@@ -546,6 +579,8 @@ function _unsupported_iterable_to_array$a(o, minLen) {
             key: "hasSubscription",
             get: /**
      * Whether any subscriptions are currently being managed.
+     *
+     * @returns true if one or more subscriptions are currently active
      */ function get() {
                 var _this__subscriptions;
                 return Boolean((_this__subscriptions = this._subscriptions) === null || _this__subscriptions === void 0 ? void 0 : _this__subscriptions.length);
@@ -578,7 +613,7 @@ function _unsupported_iterable_to_array$a(o, minLen) {
      */ key: "addSubs",
             value: function addSubs(subs) {
                 var _this__subscriptions;
-                var nextSubscriptions = _to_consumable_array$5((_this__subscriptions = this._subscriptions) !== null && _this__subscriptions !== void 0 ? _this__subscriptions : []);
+                var nextSubscriptions = _to_consumable_array$6((_this__subscriptions = this._subscriptions) !== null && _this__subscriptions !== void 0 ? _this__subscriptions : []);
                 convertToArray(subs).forEach(function(sub) {
                     if (!nextSubscriptions.includes(sub)) {
                         nextSubscriptions.push(sub);
@@ -811,24 +846,23 @@ function _unsupported_iterable_to_array$9(o, minLen) {
             key: "initFilterTakesPriority",
             value: function initFilterTakesPriority() {
                 var _this = this;
-                if (!this._initialFilterSub.subscription) {
-                    this._initialFilterSub.subscription = this._initialFilterTakesPriority.pipe(switchMap(function(clearFilterOnInitialFilterPush) {
-                        if (clearFilterOnInitialFilterPush) {
-                            return _this._initialFilter.pipe(switchMap(function(x) {
-                                return x ? x : EMPTY;
-                            }), filterMaybe(), map(function() {
-                                return true;
-                            }), skip(1) // skip the first emission
-                            );
-                        } else {
-                            return EMPTY;
-                        }
-                    }), defaultIfEmpty(false)).subscribe(function(clear) {
-                        if (clear) {
-                            _this.resetFilter();
-                        }
-                    });
-                }
+                var _this__initialFilterSub, _subscription;
+                (_subscription = (_this__initialFilterSub = this._initialFilterSub).subscription) !== null && _subscription !== void 0 ? _subscription : _this__initialFilterSub.subscription = this._initialFilterTakesPriority.pipe(switchMap(function(clearFilterOnInitialFilterPush) {
+                    if (clearFilterOnInitialFilterPush) {
+                        return _this._initialFilter.pipe(switchMap(function(x) {
+                            return x !== null && x !== void 0 ? x : EMPTY;
+                        }), filterMaybe(), map(function() {
+                            return true;
+                        }), skip(1) // skip the first emission
+                        );
+                    } else {
+                        return EMPTY;
+                    }
+                }), defaultIfEmpty(false)).subscribe(function(clear) {
+                    if (clear) {
+                        _this.resetFilter();
+                    }
+                });
             }
         },
         {
@@ -853,7 +887,7 @@ function _array_like_to_array$8(arr, len) {
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
     return arr2;
 }
-function _array_without_holes$4(arr) {
+function _array_without_holes$5(arr) {
     if (Array.isArray(arr)) return _array_like_to_array$8(arr);
 }
 function _class_call_check$6(instance, Constructor) {
@@ -887,14 +921,14 @@ function _define_property$a(obj, key, value) {
     }
     return obj;
 }
-function _iterable_to_array$4(iter) {
+function _iterable_to_array$5(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
-function _non_iterable_spread$4() {
+function _non_iterable_spread$5() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-function _to_consumable_array$4(arr) {
-    return _array_without_holes$4(arr) || _iterable_to_array$4(arr) || _unsupported_iterable_to_array$8(arr) || _non_iterable_spread$4();
+function _to_consumable_array$5(arr) {
+    return _array_without_holes$5(arr) || _iterable_to_array$5(arr) || _unsupported_iterable_to_array$8(arr) || _non_iterable_spread$5();
 }
 function _unsupported_iterable_to_array$8(o, minLen) {
     if (!o) return;
@@ -1053,6 +1087,8 @@ function _unsupported_iterable_to_array$8(o, minLen) {
         {
             /**
      * Sets the default filter observable for this key.
+     *
+     * @param filterObs - the observable to use as the default filter for this key
      */ key: "initWithFilter",
             value: function initWithFilter(filterObs) {
                 this.dbxFilterMap.addDefaultFilterObs(this.key, filterObs);
@@ -1061,6 +1097,8 @@ function _unsupported_iterable_to_array$8(o, minLen) {
         {
             /**
      * Connects a filter source, adding its filter observable to this key's merged filters.
+     *
+     * @param filterSource - the filter source whose filter$ will be added to this key's merged stream
      */ key: "connectWithSource",
             value: function connectWithSource(filterSource) {
                 this.dbxFilterMap.addFilterObs(this.key, filterSource.filter$);
@@ -1078,7 +1116,7 @@ var FilterMapItem = /*#__PURE__*/ function() {
         _define_property$a(this, "_source", new FilterSourceInstance());
         _define_property$a(this, "_obs", new BehaviorSubject([]));
         _define_property$a(this, "_obs$", this._obs.pipe(switchMap(function(x) {
-            return merge.apply(void 0, _to_consumable_array$4(x.map(function(y) {
+            return merge.apply(void 0, _to_consumable_array$5(x.map(function(y) {
                 return y.obs;
             })));
         }), distinctUntilChanged()));
@@ -1119,7 +1157,7 @@ var FilterMapItem = /*#__PURE__*/ function() {
                     var deleteOnComplete = obs.pipe(finalize(function() {
                         _this._deleteFilterObs(i);
                     })).subscribe();
-                    var nextObs = _to_consumable_array$4(currentObs).concat([
+                    var nextObs = _to_consumable_array$5(currentObs).concat([
                         {
                             i: i,
                             obs: obs,
@@ -1496,18 +1534,10 @@ function _ts_generator$1(thisArg, body) {
                     next: function next() {
                         return _async_to_generator$1(function() {
                             return _ts_generator$1(this, function(_state) {
-                                switch(_state.label){
-                                    case 0:
-                                        return [
-                                            4,
-                                            iteration.nextPage()
-                                        ];
-                                    case 1:
-                                        return [
-                                            2,
-                                            _state.sent()
-                                        ];
-                                }
+                                return [
+                                    2,
+                                    iteration.nextPage()
+                                ];
                             });
                         })();
                     }
@@ -1526,17 +1556,17 @@ function _array_like_to_array$7(arr, len) {
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
     return arr2;
 }
-function _array_without_holes$3(arr) {
+function _array_without_holes$4(arr) {
     if (Array.isArray(arr)) return _array_like_to_array$7(arr);
 }
-function _iterable_to_array$3(iter) {
+function _iterable_to_array$4(iter) {
     if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
 }
-function _non_iterable_spread$3() {
+function _non_iterable_spread$4() {
     throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
-function _to_consumable_array$3(arr) {
-    return _array_without_holes$3(arr) || _iterable_to_array$3(arr) || _unsupported_iterable_to_array$7(arr) || _non_iterable_spread$3();
+function _to_consumable_array$4(arr) {
+    return _array_without_holes$4(arr) || _iterable_to_array$4(arr) || _unsupported_iterable_to_array$7(arr) || _non_iterable_spread$4();
 }
 function _unsupported_iterable_to_array$7(o, minLen) {
     if (!o) return;
@@ -1562,7 +1592,7 @@ function scanIntoArray() {
     return scan(function(acc, next) {
         if (next != null) {
             if (immutable) {
-                acc = acc.concat(next);
+                acc = _to_consumable_array$4(acc).concat(_to_consumable_array$4(asArray(next)));
             } else {
                 acc = pushItemOrArrayItemsIntoArray(acc, next);
             }
@@ -1592,7 +1622,7 @@ function scanIntoArray() {
             }
             return acc;
         }, seed !== null && seed !== void 0 ? seed : []), distinctUntilArrayLengthChanges(), map(function(x) {
-            return _to_consumable_array$3(x);
+            return _to_consumable_array$4(x);
         }), shareReplay(1));
     });
 }
@@ -1682,7 +1712,7 @@ function scanIntoArray() {
                 if (!acc.fromMatch || requireConsecutive) {
                     fromMatch = isMatch(from, next);
                     value = next;
-                } else if (!requireConsecutive) {
+                } else {
                     value = acc.value;
                 }
             }
@@ -1716,6 +1746,8 @@ function scanIntoArray() {
 }
 /**
  * RxJS operator that negates each emitted boolean value.
+ *
+ * @returns operator that maps each boolean emission to its negated value
  */ function isNot() {
     return map(function(x) {
         return !x;
@@ -1723,6 +1755,8 @@ function scanIntoArray() {
 }
 /**
  * RxJS operator that only emits when a boolean stream transitions from `true` to `false`.
+ *
+ * @returns operator that filters to only true-to-false transition emissions
  */ function onTrueToFalse() {
     return onMatchDelta({
         from: true,
@@ -1732,6 +1766,8 @@ function scanIntoArray() {
 }
 /**
  * RxJS operator that only emits when a boolean stream transitions from `false` to `true`.
+ *
+ * @returns operator that filters to only false-to-true transition emissions
  */ function onFalseToTrue() {
     return onMatchDelta({
         from: false,
@@ -1804,7 +1840,7 @@ function scanIntoArray() {
  * time relative to the current moment.
  *
  * @param expiresIn - duration in milliseconds until expiration
- * @returns an operator that maps values to Expires objects
+ * @returns an `OperatorFunction` that maps each emission to an {@link Expires} object
  */ function toExpiration(expiresIn) {
     return map(function() {
         var now = new Date();
@@ -1819,6 +1855,8 @@ function scanIntoArray() {
 }
 /**
  * RxJS operator that filters out emissions whose {@link Expires} value has already expired.
+ *
+ * @returns operator that only passes through non-expired emissions
  */ function skipExpired() {
     return filter(function(expires) {
         return !expirationDetails({
@@ -1830,6 +1868,7 @@ function scanIntoArray() {
  * RxJS operator that skips emissions until the elapsed time since the emitted date/timestamp has exceeded `expiresIn`.
  *
  * @param expiresIn - duration in milliseconds
+ * @returns operator that skips emissions until the time window has elapsed
  */ function skipUntilExpiration(expiresIn) {
     return filter(function(x) {
         return expirationDetails({
@@ -1842,6 +1881,7 @@ function scanIntoArray() {
  * RxJS operator that skips emissions after the elapsed time since the emitted date/timestamp has exceeded `expiresIn`.
  *
  * @param expiresIn - duration in milliseconds
+ * @returns operator that passes through emissions only within the time window
  */ function skipAfterExpiration(expiresIn) {
     return filter(function(x) {
         return !expirationDetails({
@@ -1855,6 +1895,7 @@ function scanIntoArray() {
  *
  * @param watch - observable whose emissions reset the time window
  * @param takeFor - duration in milliseconds of each time window
+ * @returns operator that limits source emissions to the active time window after each watch emission
  */ function skipUntilTimeElapsedAfterLastEmission(watch, takeFor) {
     return function(observable) {
         return watch.pipe(switchMap(function() {
@@ -1874,6 +1915,7 @@ function scanIntoArray() {
  *
  * @param watch - observable whose emissions reset the skip window
  * @param skipFor - duration in milliseconds to skip after each watch emission
+ * @returns an operator that delays passing values through until time has elapsed since the last watch emission
  */ function takeAfterTimeElapsedSinceLastEmission(watch, skipFor) {
     return function(observable) {
         return watch.pipe(switchMap(function() {
@@ -2025,7 +2067,7 @@ var DEFAULT_FACTORY_TIMER_INTERVAL = 1000;
             return result;
         }), finalize(function() {
             if (currentInstance) {
-                destroy(currentInstance);
+                void destroy(currentInstance);
             }
         }));
     };
@@ -2101,6 +2143,8 @@ function tapLog(messageOrFunction) {
 
 /**
  * `distinctUntilChanged` variant that only emits when the model's `id` property changes.
+ *
+ * @returns operator that suppresses consecutive emissions with the same model `id`
  */ function distinctUntilModelIdChange() {
     return distinctUntilObjectKeyChange(function(x) {
         return x.id;
@@ -2108,6 +2152,8 @@ function tapLog(messageOrFunction) {
 }
 /**
  * `distinctUntilChanged` variant that only emits when the model's `key` property changes.
+ *
+ * @returns operator that suppresses consecutive emissions with the same model `key`
  */ function distinctUntilModelKeyChange() {
     return distinctUntilObjectKeyChange(function(x) {
         return x.key;
@@ -2423,6 +2469,12 @@ function _array_like_to_array$5(arr, len) {
 function _array_with_holes$2(arr) {
     if (Array.isArray(arr)) return arr;
 }
+function _array_without_holes$3(arr) {
+    if (Array.isArray(arr)) return _array_like_to_array$5(arr);
+}
+function _iterable_to_array$3(iter) {
+    if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
 function _iterable_to_array_limit$2(arr, i) {
     var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
     if (_i == null) return;
@@ -2450,9 +2502,15 @@ function _iterable_to_array_limit$2(arr, i) {
 function _non_iterable_rest$2() {
     throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
+function _non_iterable_spread$3() {
+    throw new TypeError("Invalid attempt to spread non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
 function _sliced_to_array$2(arr, i) {
     return _array_with_holes$2(arr) || _iterable_to_array_limit$2(arr, i) || _unsupported_iterable_to_array$5(arr, i) || _non_iterable_rest$2();
 }
+function _to_consumable_array$3(arr) {
+    return _array_without_holes$3(arr) || _iterable_to_array$3(arr) || _unsupported_iterable_to_array$5(arr) || _non_iterable_spread$3();
+}
 function _unsupported_iterable_to_array$5(o, minLen) {
     if (!o) return;
     if (typeof o === "string") return _array_like_to_array$5(o, minLen);
@@ -2470,7 +2528,7 @@ function _unsupported_iterable_to_array$5(o, minLen) {
  */ function combineLatestFromMapValuesObsFn(mapToObs) {
     var combineArrayFn = combineLatestFromArrayObsFn(mapToObs);
     return function(latestMap) {
-        var mapValues = Array.from(latestMap).map(function(y) {
+        var mapValues = _to_consumable_array$3(latestMap).map(function(y) {
             return y[1];
         });
         return combineArrayFn(mapValues);
@@ -2563,7 +2621,7 @@ function _unsupported_iterable_to_array$5(o, minLen) {
  */ function errorOnEmissionsInPeriod(config) {
     var _config_period = config.period, period = _config_period === void 0 ? 1000 : _config_period, maxEmissionsPerPeriod = config.maxEmissionsPerPeriod, onError = config.onError, inputErrorFactory = config.errorFactory, inputErrorMessage = config.errorMessage, switchToObs = config.switchToObs;
     var errorMessage = inputErrorMessage !== null && inputErrorMessage !== void 0 ? inputErrorMessage : 'errorOnEmissionsInPeriod(): Too many emissions in time period.';
-    var errorFactory = inputErrorFactory ? inputErrorFactory : !switchToObs ? function() {
+    var errorFactory = inputErrorFactory !== null && inputErrorFactory !== void 0 ? inputErrorFactory : !switchToObs ? function() {
         return new Error(errorMessage);
     } : undefined;
     return function(source) {
@@ -2623,6 +2681,8 @@ function _unsupported_iterable_to_array$5(o, minLen) {
 }
 /**
  * `distinctUntilChanged` variant for iterables that only emits when the contained values change.
+ *
+ * @returns operator that suppresses consecutive iterable emissions with the same set of values
  */ function distinctUntilHasDifferentValues() {
     return distinctUntilChanged(hasSameValues);
 }
@@ -2876,7 +2936,8 @@ function _unsupported_iterable_to_array$4(o, minLen) {
         if (loading === true) {
             result = false;
         } else {
-            result = loading === false || Boolean(state.value || state.error) || state.value === null;
+            var _state_value;
+            result = loading === false || Boolean((_state_value = state.value) !== null && _state_value !== void 0 ? _state_value : state.error) || state.value === null;
         }
     }
     return result;
@@ -2892,6 +2953,8 @@ function _unsupported_iterable_to_array$4(o, minLen) {
  * // { loading: false }
  * loadingStateType(state); // LoadingStateType.IDLE
  * ```
+ *
+ * @returns a loading state with `loading: false` and no value or error
  */ function idleLoadingState() {
     return {
         loading: false
@@ -3016,8 +3079,7 @@ function beginLoading(state) {
  */ function isLoadingStateWithStateType(type) {
     var defaultResult = type === LoadingStateType.IDLE ? true : false;
     return function(state) {
-        var result = state ? loadingStateType(state) === type : defaultResult;
-        return result;
+        return state ? loadingStateType(state) === type : defaultResult;
     };
 }
 /**
@@ -3060,8 +3122,7 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has a defined (non-undefined) value
  */ function isLoadingStateWithDefinedValue(state) {
-    var result = state ? state.value !== undefined : false;
-    return result;
+    return state ? state.value !== undefined : false;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has a non-null error, regardless of loading status.
@@ -3075,8 +3136,7 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if the state has an error
  */ function isLoadingStateWithError(state) {
-    var result = state ? state.error != null : false;
-    return result;
+    return state ? state.error != null : false;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has a defined value.
@@ -3084,8 +3144,7 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with a non-undefined value
  */ function isLoadingStateFinishedLoadingWithDefinedValue(state) {
-    var result = state ? isLoadingStateFinishedLoading(state) && state.value !== undefined : false;
-    return result;
+    return state ? isLoadingStateFinishedLoading(state) && state.value !== undefined : false;
 }
 /**
  * Type guard that checks whether a {@link LoadingState} has finished loading and has an error.
@@ -3093,8 +3152,7 @@ function beginLoading(state) {
  * @param state - the loading state to check
  * @returns true if finished loading with an error
  */ function isLoadingStateFinishedLoadingWithError(state) {
-    var result = state ? isLoadingStateFinishedLoading(state) && state.error != null : false;
-    return result;
+    return state ? isLoadingStateFinishedLoading(state) && state.error != null : false;
 }
 /**
  * Compares the metadata (page, loading, error) of two {@link PageLoadingState} instances for equivalence.
@@ -3120,12 +3178,13 @@ function beginLoading(state) {
  */ function isPageLoadingStateMetadataEqual(a, b) {
     return valuesAreBothNullishOrEquivalent(a.page, b.page) && a.loading == b.loading && valuesAreBothNullishOrEquivalent(a.error, b.error);
 }
+// eslint-disable-next-line jsdoc/require-jsdoc -- JSDoc is on the overload signatures above
 function mergeLoadingStates() {
     for(var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++){
         args[_key] = arguments[_key];
     }
     var _loadingStates_find;
-    var validArgs = filterMaybeArrayValues(args); // filter out any undefined values
+    /* eslint-enable @typescript-eslint/max-params */ var validArgs = filterMaybeArrayValues(args); // filter out any undefined values
     var lastValueIsMergeFn = typeof validArgs[validArgs.length - 1] === 'function';
     var loadingStates = lastValueIsMergeFn ? validArgs.slice(0, validArgs.length - 1) : validArgs;
     var mergeFn = lastValueIsMergeFn ? args[validArgs.length - 1] : function() {
@@ -3141,7 +3200,7 @@ function mergeLoadingStates() {
     if (error) {
         // ignore all loading states, except for any error-prone item that is still loading
         var currentLoadings = loadingStates.map(function(x) {
-            return (x === null || x === void 0 ? void 0 : x.error) ? x.loading : false;
+            return x.error ? x.loading : false;
         });
         var nonMaybeLoadings = currentLoadings.filter(function(x) {
             return x != null;
@@ -3227,10 +3286,10 @@ function mergeLoadingStates() {
     var mapValues = config.mapValues, mapState = config.mapState;
     var loading = isAnyLoadingStateInLoadingState(input);
     var error = input.map(function(x) {
-        return x === null || x === void 0 ? void 0 : x.error;
-    }).filter(function(x) {
+        return x.error;
+    }).find(function(x) {
         return Boolean(x);
-    })[0];
+    });
     var result;
     if (!error && !loading) {
         if (mapValues) {
@@ -3252,7 +3311,7 @@ function mergeLoadingStates() {
 }
 function mapLoadingStateResults(input, config) {
     var mapValue = config.mapValue, mapState = config.mapState, _config_alwaysMapValue = config.alwaysMapValue, alwaysMapValue = _config_alwaysMapValue === void 0 ? false : _config_alwaysMapValue;
-    var inputValue = input === null || input === void 0 ? void 0 : input.value;
+    var inputValue = input.value;
     var value;
     if ((inputValue != null || alwaysMapValue) && mapValue) {
         value = mapValue(inputValue, input);
@@ -3388,28 +3447,23 @@ function _unsupported_iterable_to_array$3(o, minLen) {
         return of(errorResult(error));
     }), timeoutStartWith(beginLoading(), 50), shareReplay(1));
 }
+// eslint-disable-next-line jsdoc/require-jsdoc -- JSDoc is on the overload signatures above
 function combineLoadingStates() {
     for(var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++){
         args[_key] = arguments[_key];
     }
-    var validArgs = filterMaybeArrayValues(args); // filter out any undefined values
+    /* eslint-enable @typescript-eslint/max-params */ var validArgs = filterMaybeArrayValues(args); // filter out any undefined values
     var lastValueIsMergeFn = typeof validArgs[validArgs.length - 1] === 'function';
     var obsArgs = lastValueIsMergeFn ? validArgs.slice(0, validArgs.length - 1) : validArgs;
     var mergeFn = lastValueIsMergeFn ? validArgs[validArgs.length - 1] : undefined;
     return combineLatest(obsArgs).pipe(distinctUntilChanged(function(x, y) {
-        if (x && y) {
-            var hasSameValues = x.findIndex(function(_, i) {
-                return x[i] !== y[i];
-            }) === -1;
-            return hasSameValues;
-        } else {
-            return x === y;
-        }
+        return !x.some(function(_, i) {
+            return x[i] !== y[i];
+        });
     }), map(function(states) {
-        var result = mergeLoadingStates.apply(void 0, _to_consumable_array$1(states).concat([
+        return mergeLoadingStates.apply(void 0, _to_consumable_array$1(states).concat([
             mergeFn
         ]));
-        return result;
     }), shareReplay(1) // Share the result.
     );
 }
@@ -3444,7 +3498,7 @@ function combineLoadingStates() {
         if (firstErrorState) {
             result = errorResult(firstErrorState.error);
         } else {
-            var oneOrMoreStatesAreCurrentlyLoading = allLoadingStates.findIndex(isLoadingStateLoading) !== -1;
+            var oneOrMoreStatesAreCurrentlyLoading = allLoadingStates.some(isLoadingStateLoading);
             if (oneOrMoreStatesAreCurrentlyLoading) {
                 result = beginLoading(); // still loading
             } else {
@@ -3572,7 +3626,7 @@ function tapOnLoadingStateType(fn, type) {
         };
     }
     return tap(function(state) {
-        if (state != null && decisionFunction(state)) {
+        if (decisionFunction(state)) {
             fn(state);
         }
     });
@@ -3724,6 +3778,10 @@ function distinctLoadingState(inputConfig) {
  *
  * Determines the `loading` flag based on whether an error is present, whether the value is defined,
  * and the `showLoadingOnUndefinedValue` setting. Loading progress is only included while loading.
+ *
+ * @param state - the current loading state to convert into a context event
+ * @param input - configuration input controlling how the loading flag is derived
+ * @returns a loading state context event derived from the given state
  */ var DEFAULT_LOADING_EVENT_FOR_LOADING_PAIR_FUNCTION = function DEFAULT_LOADING_EVENT_FOR_LOADING_PAIR_FUNCTION(state, input) {
     var showLoadingOnUndefinedValue = input.showLoadingOnUndefinedValue;
     var error = state.error, value = state.value, loadingProgress = state.loadingProgress;
@@ -3794,7 +3852,7 @@ function distinctLoadingState(inputConfig) {
         return result;
     }), distinctUntilChanged(isLoadingStateEqual), shareReplay(1));
     var currentState$ = currentStateStream$.pipe(switchMap(function(x) {
-        return x ? x : of(undefined);
+        return x !== null && x !== void 0 ? x : of(undefined);
     }));
     var state$ = currentState$.pipe(filterMaybe(), shareReplay(1));
     var loading$ = eventStream$.pipe(map(isLoadingStateLoading));
@@ -3838,7 +3896,8 @@ function distinctLoadingState(inputConfig) {
  * @param listLoadingState - the list loading state to check
  * @returns true if the value is empty or absent
  */ function isListLoadingStateWithEmptyValue(listLoadingState) {
-    return Boolean(!listLoadingState.value || !listLoadingState.value.length);
+    var _listLoadingState_value;
+    return Boolean(!((_listLoadingState_value = listLoadingState.value) === null || _listLoadingState_value === void 0 ? void 0 : _listLoadingState_value.length));
 }
 /**
  * RxJS operator that maps each emitted {@link ListLoadingState} to a boolean indicating whether the list is empty.
@@ -4120,6 +4179,8 @@ function _object_spread_props$3(target, source) {
         {
             /**
      * Whether the current state has a non-null error.
+     *
+     * @returns true if the current state contains an error
      */ key: "hasError",
             value: function hasError() {
                 return isLoadingStateWithError(this._subject.value);
@@ -4612,55 +4673,48 @@ function itemAccumulator(itemIteration, inputMapItem) {
             return from(asPromise(countResults(allItems)));
         })).subscribe({
             next: function next(currentResultsCount) {
-                return _async_to_generator(function() {
-                    return _ts_generator(this, function(_state) {
-                        performTaskLoop({
-                            initValue: currentResultsCount,
-                            checkContinue: function checkContinue(x, i) {
-                                return _async_to_generator(function() {
-                                    var result;
-                                    return _ts_generator(this, function(_state) {
-                                        switch(_state.label){
-                                            case 0:
-                                                return [
-                                                    4,
-                                                    checkResultsLimit()
-                                                ];
-                                            case 1:
-                                                result = _state.sent();
-                                                currentResultsCount = result.currentCount;
-                                                return [
-                                                    2,
-                                                    result.shouldContinue
-                                                ];
-                                        }
-                                    });
-                                })();
-                            },
-                            next: function next() {
-                                return _async_to_generator(function() {
-                                    return _ts_generator(this, function(_state) {
+                performTaskLoop({
+                    initValue: currentResultsCount,
+                    checkContinue: function checkContinue(_x, _i) {
+                        return _async_to_generator(function() {
+                            var result;
+                            return _ts_generator(this, function(_state) {
+                                switch(_state.label){
+                                    case 0:
+                                        return [
+                                            4,
+                                            checkResultsLimit()
+                                        ];
+                                    case 1:
+                                        result = _state.sent();
+                                        currentResultsCount = result.currentCount;
                                         return [
                                             2,
-                                            accumulator.itemIteration.nextPage()
+                                            result.shouldContinue
                                         ];
-                                    });
-                                })();
-                            }
-                        }).then(function(page) {
-                            resolve({
-                                page: page,
-                                resultsCount: currentResultsCount
+                                }
                             });
-                        }).catch(function(error) {
-                            reject(error);
-                            throw error;
-                        });
-                        return [
-                            2
-                        ];
+                        })();
+                    },
+                    next: function next() {
+                        return _async_to_generator(function() {
+                            return _ts_generator(this, function(_state) {
+                                return [
+                                    2,
+                                    accumulator.itemIteration.nextPage()
+                                ];
+                            });
+                        })();
+                    }
+                }).then(function(page) {
+                    resolve({
+                        page: page,
+                        resultsCount: currentResultsCount
                     });
-                })();
+                }).catch(function(error) {
+                    reject(error);
+                    throw error;
+                });
             },
             error: function error(error) {
                 reject(error);
@@ -5159,11 +5213,10 @@ function _unsupported_iterable_to_array(o, minLen) {
                         hasNextPage: invertMaybeBoolean(end)
                     });
                 }
-                var result = {
+                return {
                     n: request.n,
                     state: state
                 };
-                return result;
             }));
         }), scan(function(acc, x) {
             var n = x.n, curr = x.state;
@@ -5176,19 +5229,15 @@ function _unsupported_iterable_to_array(o, minLen) {
                 lastSuccessful: acc.lastSuccessful
             };
             // If it was a replay of the previous result, change nothing.
-            if (acc.current !== curr) {
-                if (isLoadingStateFinishedLoading(curr)) {
-                    // only set first finished once
-                    if (!next.firstFinished) {
-                        next.firstFinished = curr;
-                    }
-                    next.latestFinished = curr;
-                    if (!isLoadingStateWithError(curr)) {
-                        next.lastSuccessful = curr;
-                        if (!next.firstSuccessful) {
-                            next.firstSuccessful = curr;
-                        }
-                    }
+            if (acc.current !== curr && isLoadingStateFinishedLoading(curr)) {
+                var // only set first finished once
+                _next, _firstFinished;
+                (_firstFinished = (_next = next).firstFinished) !== null && _firstFinished !== void 0 ? _firstFinished : _next.firstFinished = curr;
+                next.latestFinished = curr;
+                if (!isLoadingStateWithError(curr)) {
+                    var _next1, _firstSuccessful;
+                    next.lastSuccessful = curr;
+                    (_firstSuccessful = (_next1 = next).firstSuccessful) !== null && _firstSuccessful !== void 0 ? _firstSuccessful : _next1.firstSuccessful = curr;
                 }
             }
             return next;
@@ -5497,6 +5546,10 @@ function _type_of(obj) {
  * Useful for deferring an action until all locks are released, with a safety timeout to avoid waiting indefinitely.
  *
  * @param config - configuration specifying the lock set, callback, timeout, and optional delay
+ * @param config.lockSet - the lock set to monitor for the next unlock event
+ * @param config.fn - optional callback to invoke when the lock set unlocks or the timeout is reached
+ * @param config.timeout - maximum time in milliseconds to wait before timing out
+ * @param config.delayTime - optional delay in milliseconds after unlock before invoking the callback
  * @returns subscription that can be unsubscribed to cancel the wait
  *
  * @example
@@ -5924,14 +5977,14 @@ function _define_property(obj, key, value) {
      *
      * If the loading state returns an error, the error is forwarded.
      *
-     * @param loadingStateObs
+     * @param loadingStateObs - observable of the loading state to track as the work result
      */ key: "startWorkingWithLoadingStateObservable",
             value: function startWorkingWithLoadingStateObservable(loadingStateObs) {
                 var _this = this;
                 var obs = preventComplete(loadingStateObs).pipe(filterMaybe(), shareReplay(1));
                 this._sub.subscription = obs.pipe(delay(0), first()).subscribe(function() {
                     _this.startWorkingWithObservable(obs.pipe(filter(function(x) {
-                        return x && !isLoadingStateLoading(x);
+                        return !isLoadingStateLoading(x);
                     }), map(function(x) {
                         if (x.error) {
                             throw x.error;
@@ -5950,11 +6003,12 @@ function _define_property(obj, key, value) {
      *
      * It is used in conjunction with startWorking() and ideal for cases where multiple observables or promises are used.
      *
-     * @param loadingStateObs
+     * @param loadingStateObs - promise or observable of the loading state to track for errors
+     * @returns a promise that resolves with the value from the loading state or rejects on error
      */ key: "performTaskWithLoadingState",
             value: function performTaskWithLoadingState(loadingStateObs) {
                 var _this = this;
-                return promiseFromLoadingState(from(loadingStateObs).pipe(filterMaybe(), tap(function(x) {
+                return promiseFromLoadingState(from(loadingStateObs).pipe(filterMaybe(), tap(function(_x) {
                     _this._setWorking(true); // mark as working if not already marked.
                 }))).catch(function(e) {
                     // catch and throw any errors.
@@ -5969,7 +6023,7 @@ function _define_property(obj, key, value) {
      *
      * If an error is thrown, the error is forwarded to the reject function.
      *
-     * @param fn
+     * @param fn - synchronous function that returns the result value or throws an error
      */ key: "performTaskWithReturnValue",
             value: function performTaskWithReturnValue(fn) {
                 try {
@@ -5984,6 +6038,8 @@ function _define_property(obj, key, value) {
         {
             /**
      * Begins working using a promise.
+     *
+     * @param promise - the promise that represents the asynchronous work
      */ key: "startWorkingWithPromise",
             value: function startWorkingWithPromise(promise) {
                 this.startWorkingWithObservable(from(promise));
@@ -5992,6 +6048,8 @@ function _define_property(obj, key, value) {
         {
             /**
      * Begins working using an observable.
+     *
+     * @param workObs - the observable that represents the asynchronous work and emits the result
      */ key: "startWorkingWithObservable",
             value: function startWorkingWithObservable(workObs) {
                 var _this = this;
@@ -6018,6 +6076,8 @@ function _define_property(obj, key, value) {
         {
             /**
      * Sets success on the work.
+     *
+     * @param result - the successful result value to pass to the delegate
      */ key: "success",
             value: function success(result) {
                 this._setComplete(successResult(result));
@@ -6027,6 +6087,8 @@ function _define_property(obj, key, value) {
         {
             /**
      * Sets rejected on the work.
+     *
+     * @param error - the error to pass to the delegate as the rejection reason
      */ key: "reject",
             value: function reject(error) {
                 this._setComplete(errorResult(error));
@@ -6088,6 +6150,8 @@ function _define_property(obj, key, value) {
  * ```
  *
  * @param config - work function and delegate configuration
+ * @param config.work - the work function to execute for each input value
+ * @param config.delegate - delegate that receives lifecycle callbacks (start, success, reject)
  * @returns a factory function that creates WorkInstance for each input
  */ function workFactory(param) {
     var work = param.work, delegate = param.delegate;
@@ -6101,13 +6165,11 @@ function _define_property(obj, key, value) {
             handler.reject(e);
             return;
         }
-        if (!handler.isComplete) {
-            if (fnResult && isObservable(fnResult)) {
-                if (handler.hasStarted) {
-                    throw new Error('Work already marked as begun from returned result. Either return an observable or use the handler directly.');
-                }
-                handler.startWorkingWithObservable(fnResult);
+        if (!handler.isComplete && fnResult && isObservable(fnResult)) {
+            if (handler.hasStarted) {
+                throw new Error('Work already marked as begun from returned result. Either return an observable or use the handler directly.');
             }
+            handler.startWorkingWithObservable(fnResult);
         }
         return handler;
     };