@dereekb/rxjs 13.11.14 → 13.11.15

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dereekb/rxjs",
-  "version": "13.11.14",
+  "version": "13.11.15",
   "sideEffects": false,
   "peerDependencies": {
     "rxjs": "^7.8.2",
-    "@dereekb/util": "13.11.14"
+    "@dereekb/util": "13.11.15"
   },
   "exports": {
     "./package.json": "./package.json",

package/src/lib/asset/asset.builder.d.ts

@@ -3,14 +3,14 @@ import { type AssetLocalPathRef, type AssetRemotePathRef } from './asset';
 /**
  * Creates a local {@link AssetLocalPathRef}.
  *
+ * @param path - Relative path from the environment's base asset directory.
+ * @returns A local asset reference with the given path.
+ *
  * @example
  * ```ts
  * const DISTRICTS = localAsset('data/school-districts.json');
  * // { sourceType: 'local', path: 'data/school-districts.json' }
  * ```
- *
- * @param path - Relative path from the environment's base asset directory.
- * @returns A local asset reference with the given path.
  */
 export declare function localAsset(path: SlashPath): AssetLocalPathRef;
 /**
@@ -19,15 +19,15 @@ export declare function localAsset(path: SlashPath): AssetLocalPathRef;
  * Remote assets always use absolute URLs with an http:// or https:// prefix.
  * Throws if the provided URL does not have a valid prefix.
  *
+ * @param url - Absolute URL with http/https prefix to fetch the asset from.
+ * @returns A remote asset reference with the given URL.
+ * @throws {Error} If the URL does not have a valid http/https prefix.
+ *
  * @example
  * ```ts
  * const CDN = remoteAsset('https://cdn.example.com/geo.json');
  * // { sourceType: 'remote', url: 'https://cdn.example.com/geo.json' }
  * ```
- *
- * @param url - Absolute URL with http/https prefix to fetch the asset from.
- * @returns A remote asset reference with the given URL.
- * @throws Error if the URL does not have a valid http/https prefix.
  */
 export declare function remoteAsset(url: WebsiteUrlWithPrefix): AssetRemotePathRef;
 /**
@@ -52,6 +52,9 @@ export interface AssetFolderBuilder {
  * Creates a fluent builder for creating multiple local asset refs
  * from the same folder.
  *
+ * @param folder - Base folder path for the assets.
+ * @returns A fluent builder for creating local asset refs within the specified folder.
+ *
  * @example
  * ```ts
  * const DATA = assetFolder('data');
@@ -65,9 +68,6 @@ export interface AssetFolderBuilder {
  * //   { sourceType: 'local', path: 'data/b.txt' }
  * // ]
  * ```
- *
- * @param folder - Base folder path for the assets.
- * @returns A fluent builder for creating local asset refs within the specified folder.
  */
 export declare function assetFolder(folder: SlashPath): AssetFolderBuilder;
 /**
@@ -95,6 +95,10 @@ export interface RemoteAssetBuilder {
  * The base URL must be a valid {@link WebsiteUrlWithPrefix}.
  * Each child path is appended to produce a full absolute URL.
  *
+ * @param baseUrl - Base URL with http/https prefix.
+ * @returns A fluent builder for creating remote asset refs under the specified base URL.
+ * @throws {Error} If the base URL does not have a valid http/https prefix.
+ *
  * @example
  * ```ts
  * const CDN = remoteAssetBaseUrl('https://cdn.example.com/assets');
@@ -108,9 +112,5 @@ export interface RemoteAssetBuilder {
  * //   { sourceType: 'remote', url: 'https://cdn.example.com/assets/b.json' }
  * // ]
  * ```
- *
- * @param baseUrl - Base URL with http/https prefix.
- * @returns A fluent builder for creating remote asset refs under the specified base URL.
- * @throws Error if the base URL does not have a valid http/https prefix.
  */
 export declare function remoteAssetBaseUrl(baseUrl: WebsiteUrlWithPrefix): RemoteAssetBuilder;

package/src/lib/asset/asset.loader.d.ts

@@ -5,15 +5,15 @@ import { type AssetPathRef, type AssetLoaderAssetInstance, type AssetLoaderGetFn
  * The returned {@link AssetLoaderAssetInstance.load} observable is cold — each subscription
  * invokes the get function anew.
  *
+ * @param ref - The asset path reference this instance represents.
+ * @param getFn - Promise-based function that loads the asset bytes.
+ * @returns An {@link AssetLoaderAssetInstance} with a cold observable that invokes getFn on each subscription.
+ *
  * @example
  * ```ts
  * const instance = assetLoaderAssetInstance(ref, (r) => fetch(r.path).then(res => res.arrayBuffer()));
  * instance.load().subscribe((data) => { ... });
  * ```
- *
- * @param ref - The asset path reference this instance represents.
- * @param getFn - Promise-based function that loads the asset bytes.
- * @returns An {@link AssetLoaderAssetInstance} with a cold observable that invokes getFn on each subscription.
  */
 export declare function assetLoaderAssetInstance(ref: AssetPathRef, getFn: AssetLoaderGetFn): AssetLoaderAssetInstance;
 /**
@@ -22,6 +22,9 @@ export declare function assetLoaderAssetInstance(ref: AssetPathRef, getFn: Asset
  * This is the primary helper for building functional AssetLoader implementations
  * from a Promise-based leaf loader.
  *
+ * @param getFn - Promise-based function that loads any asset's bytes.
+ * @returns An {@link AssetLoader} that creates instances using the provided get function.
+ *
  * @example
  * ```ts
  * const loader = assetLoaderFromGetFn(async (ref) => {
@@ -29,8 +32,5 @@ export declare function assetLoaderAssetInstance(ref: AssetPathRef, getFn: Asset
  *   return response.arrayBuffer();
  * });
  * ```
- *
- * @param getFn - Promise-based function that loads any asset's bytes.
- * @returns An {@link AssetLoader} that creates instances using the provided get function.
  */
 export declare function assetLoaderFromGetFn(getFn: AssetLoaderGetFn): AssetLoader;

package/src/lib/asset/asset.loader.delegated.d.ts

@@ -20,6 +20,9 @@ export interface DelegatedAssetLoaderConfig {
  * loader together, and the delegated loader routes each {@link AssetPathRef}
  * to the correct one based on {@link AssetPathRef.sourceType}.
  *
+ * @param config - Specifies the local and remote delegate loaders.
+ * @returns An {@link AssetLoader} that routes requests to the appropriate delegate based on source type.
+ *
  * @example
  * ```ts
  * const loader = delegatedAssetLoader({
@@ -30,8 +33,5 @@ export interface DelegatedAssetLoaderConfig {
  * loader.get(localAsset('data/districts.json'));   // → local loader
  * loader.get(remoteAsset('data/geo.json'));        // → remote loader
  * ```
- *
- * @param config - Specifies the local and remote delegate loaders.
- * @returns An {@link AssetLoader} that routes requests to the appropriate delegate based on source type.
  */
 export declare function delegatedAssetLoader(config: DelegatedAssetLoaderConfig): AssetLoader;

package/src/lib/asset/asset.loader.fetch.d.ts

@@ -17,6 +17,9 @@ export interface FetchAssetLoaderConfig {
  *
  * Remote refs always have absolute URLs, so no base URL resolution is needed.
  *
+ * @param config - Optional fetch configuration with custom fetch function.
+ * @returns An {@link AssetLoader} that loads remote assets via HTTP fetch.
+ *
  * @example
  * ```ts
  * const loader = fetchAssetLoader();
@@ -27,8 +30,5 @@ export interface FetchAssetLoaderConfig {
  * // With a custom fetch function:
  * const loader = fetchAssetLoader({ fetch: myAuthenticatedFetch });
  * ```
- *
- * @param config - Optional fetch configuration with custom fetch function.
- * @returns An {@link AssetLoader} that loads remote assets via HTTP fetch.
  */
 export declare function fetchAssetLoader(config?: FetchAssetLoaderConfig): AssetLoader;

package/src/lib/asset/asset.loader.memory.d.ts

@@ -6,6 +6,9 @@ import { type AssetPathRef, type AssetLoader } from './asset';
  * Assets are matched by reference identity — the same {@link AssetPathRef}
  * object used to populate the map must be used to retrieve the data.
  *
+ * @param assets - Map of asset refs to their raw byte data.
+ * @returns An {@link AssetLoader} backed by the provided in-memory map.
+ *
  * @example
  * ```ts
  * const DISTRICTS = localAsset('districts.json');
@@ -15,8 +18,5 @@ import { type AssetPathRef, type AssetLoader } from './asset';
  *
  * loader.get(DISTRICTS).load().subscribe((data) => { ... });
  * ```
- *
- * @param assets - Map of asset refs to their raw byte data.
- * @returns An {@link AssetLoader} backed by the provided in-memory map.
  */
 export declare function memoryAssetLoader(assets: Map<AssetPathRef, ArrayBuffer>): AssetLoader;

package/src/lib/filter/filter.map.d.ts

@@ -31,38 +31,38 @@ export declare class FilterMap<F> implements Destroyable {
      *
      * Waits until a filter entry exists for the key, then switches to its filter stream.
      *
-     * @param key - filter map key to observe
-     * @returns observable that emits the current filter value for the key
+     * @param key - Filter map key to observe.
+     * @returns Observable that emits the current filter value for the key.
      */
     filterForKey(key: FilterMapKey): Observable<F>;
     /**
      * Sets a default filter observable for the given key, used as a fallback when no explicit filter is set.
      *
-     * @param key - filter map key
-     * @param obs - default filter observable or value
+     * @param key - Filter map key.
+     * @param obs - Default filter observable or value.
      */
     addDefaultFilterObs(key: FilterMapKey, obs: Maybe<ObservableOrValue<F>>): void;
     /**
      * Adds a filter observable for the given key. Multiple observables can be added per key
      * and their emissions are merged together.
      *
-     * @param key - filter map key
-     * @param obs - filter observable to add
+     * @param key - Filter map key.
+     * @param obs - Filter observable to add.
      */
     addFilterObs(key: FilterMapKey, obs: Observable<F>): void;
     /**
      * Creates a {@link FilterMapKeyInstance} bound to the given key, providing both
      * {@link FilterSource} and {@link FilterSourceConnector} interfaces for that key.
      *
-     * @param key - filter map key to bind
-     * @returns instance for interacting with the filter at the given key
+     * @param key - Filter map key to bind.
+     * @returns Instance for interacting with the filter at the given key.
      */
     makeInstance(key: FilterMapKey): FilterMapKeyInstance<F>;
     /**
      * Creates an observable that emits a new {@link FilterMapKeyInstance} each time the key changes.
      *
-     * @param keyObs - observable of filter map keys
-     * @returns observable that emits instances for the current key
+     * @param keyObs - Observable of filter map keys.
+     * @returns Observable that emits instances for the current key.
      */
     instanceObsForKeyObs(keyObs: Observable<FilterMapKey>): Observable<FilterMapKeyInstance<F>>;
     private _itemForKey;
@@ -90,13 +90,13 @@ export declare class FilterMapKeyInstance<F> implements FilterSourceConnector<F>
     /**
      * Sets the default filter observable for this key.
      *
-     * @param filterObs - the observable to use as the default filter for this key
+     * @param filterObs - The observable to use as the default filter for this key.
      */
     initWithFilter(filterObs: Observable<F>): void;
     /**
      * 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
+     * @param filterSource - The filter source whose filter$ will be added to this key's merged stream.
      */
     connectWithSource(filterSource: FilterSource<F>): void;
 }

package/src/lib/filter/filter.preset.d.ts

@@ -12,8 +12,8 @@ export type MapFilterWithPresetFn<F extends FilterWithPreset> = (filter: F) => F
  * into concrete filter values, then the `preset` field is removed from the result.
  * Filters without a preset are passed through unchanged.
  *
- * @param fn - function that expands a preset into concrete filter values
- * @returns mapping function that resolves presets and strips the preset field
+ * @param fn - Function that expands a preset into concrete filter values.
+ * @returns Mapping function that resolves presets and strips the preset field.
  *
  * @example
  * ```ts
@@ -29,13 +29,14 @@ export type MapFilterWithPresetFn<F extends FilterWithPreset> = (filter: F) => F
  * const result = resolve({ preset: 'active' });
  * // result === { active: true }
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeMapFilterWithPresetFn<F extends FilterWithPreset>(fn: MapFilterWithPresetFn<F>): MapFilterWithPresetFn<F>;
 /**
  * RxJS operator that resolves preset references in a filter stream using the provided mapping function.
  *
- * @param fn - function that expands a preset into concrete filter values
- * @returns operator that maps filter emissions, resolving any preset references
+ * @param fn - Function that expands a preset into concrete filter values.
+ * @returns Operator that maps filter emissions, resolving any preset references.
  */
 export declare function mapFilterWithPreset<F extends FilterWithPreset>(fn: MapFilterWithPresetFn<F>): OperatorFunction<F, FilterWithoutPresetString<F>>;

package/src/lib/filter/filter.source.d.ts

@@ -68,19 +68,19 @@ export declare class FilterSourceInstance<F> implements FilterSource<F>, Destroy
     /**
      * Sets an initial filter observable that takes priority over the default filter.
      *
-     * @param filterObs - observable providing the initial filter value
+     * @param filterObs - Observable providing the initial filter value.
      */
     initWithFilter(filterObs: Observable<F>): void;
     /**
      * Sets the default filter, used as a fallback when no explicit or initial filter is active.
      *
-     * @param filter - default filter value, observable, or undefined to clear
+     * @param filter - Default filter value, observable, or undefined to clear.
      */
     setDefaultFilter(filter: MaybeObservableOrValue<F>): void;
     /**
      * Sets an explicit filter value that takes priority over the initial and default filters.
      *
-     * @param filter - the filter value to set
+     * @param filter - The filter value to set.
      */
     setFilter(filter: F): void;
     /**
@@ -93,7 +93,7 @@ export declare class FilterSourceInstance<F> implements FilterSource<F>, Destroy
      * When enabled, any new emission from the initial filter observable clears the explicit
      * filter, causing `filter$` to fall back to the initial filter value.
      *
-     * @param initialFilterTakesPriority - whether initial filter changes should reset the explicit filter
+     * @param initialFilterTakesPriority - Whether initial filter changes should reset the explicit filter.
      */
     setInitialFilterTakesPriority(initialFilterTakesPriority: boolean): void;
     protected initFilterTakesPriority(): void;

package/src/lib/iterator/iteration.accumulator.d.ts

@@ -124,9 +124,8 @@ export interface ItemAccumulatorNextPageUntilResultsCountResult extends Page {
  * Automatically pages through an accumulator's iteration until the desired number of results
  * is reached or no more pages are available.
  *
- * @param config - configuration specifying the accumulator, result limit, and counting function
- * @returns promise resolving to the final page number and total results count
- *
- * @throws Rejects if the iteration encounters an error during loading
+ * @param config - Configuration specifying the accumulator, result limit, and counting function.
+ * @returns Promise resolving to the final page number and total results count.
+ * @throws {Error} Rejects if the iteration encounters a loading error.
  */
 export declare function itemAccumulatorNextPageUntilResultsCount<O>(config: ItemAccumulatorNextPageUntilResultsCountConfig<O>): Promise<ItemAccumulatorNextPageUntilResultsCountResult>;

package/src/lib/iterator/iteration.accumulator.rxjs.d.ts

@@ -7,8 +7,8 @@ import { type ItemAccumulator, type PageItemAccumulator } from './iteration.accu
  * Designed for accumulators where each page returns an array of items. Concatenates all
  * page results into one flat array that grows as new pages are loaded.
  *
- * @param accumulator - accumulator whose page results are arrays to flatten
- * @returns observable emitting the flattened array of all accumulated items
+ * @param accumulator - Accumulator whose page results are arrays to flatten.
+ * @returns Observable emitting the flattened array of all accumulated items.
  */
 export declare function flattenAccumulatorResultItemArray<T, I = unknown>(accumulator: ItemAccumulator<T[], I>): Observable<T[]>;
 /**
@@ -18,8 +18,8 @@ export declare function flattenAccumulatorResultItemArray<T, I = unknown>(accumu
  * The loading state reflects whether a page is currently being fetched, while the value
  * always contains the full flattened array of all items loaded so far.
  *
- * @param accumulator - page accumulator whose results are arrays to flatten
- * @returns observable of the combined loading state with all accumulated items
+ * @param accumulator - Page accumulator whose results are arrays to flatten.
+ * @returns Observable of the combined loading state with all accumulated items.
  */
 export declare function accumulatorFlattenPageListLoadingState<T, I = unknown>(accumulator: PageItemAccumulator<T[], I>): Observable<PageListLoadingState<T>>;
 /**
@@ -29,14 +29,14 @@ export declare function accumulatorFlattenPageListLoadingState<T, I = unknown>(a
  * Unlike {@link accumulatorFlattenPageListLoadingState}, this does not flatten arrays —
  * each accumulated value is included as-is.
  *
- * @param accumulator - page accumulator to observe
- * @returns observable of the combined loading state with all accumulated items
+ * @param accumulator - Page accumulator to observe.
+ * @returns Observable of the combined loading state with all accumulated items.
  */
 export declare function accumulatorCurrentPageListLoadingState<V, I = unknown>(accumulator: PageItemAccumulator<V, I>): Observable<PageListLoadingState<V>>;
 /**
  * Returns the latest loaded page number from the input accumulator's underlying iteration.
  *
- * @param pageItemAccumulator - accumulator to observe the current page from
- * @returns observable emitting the most recently loaded page number
+ * @param pageItemAccumulator - Accumulator to observe the current page from.
+ * @returns Observable emitting the most recently loaded page number.
  */
 export declare function pageItemAccumulatorCurrentPage(pageItemAccumulator: PageItemAccumulator<any, any>): Observable<number>;

package/src/lib/iterator/iteration.mapped.d.ts

@@ -21,7 +21,7 @@ export interface MappedItemIterationInstanceMapConfig<O, I, M extends LoadingSta
      * Whether destroying the mapped instance also destroys the underlying iteration.
      * Defaults to `true`.
      */
-    forwardDestroy?: boolean;
+    readonly forwardDestroy?: boolean;
 }
 /**
  * Concrete instance of a mapped item iteration, exposing the transformed state observables
@@ -43,8 +43,8 @@ export interface MappedItemIterationInstance<O, I = unknown, M extends LoadingSt
  *
  * Control flow (next, hasNext, canLoadMore) is delegated directly to the underlying iteration.
  *
- * @param itemIterator - the source iteration to wrap
- * @param config - mapping configuration for transforming loading state values
- * @returns mapped iteration instance with transformed state observables
+ * @param itemIterator - The source iteration to wrap.
+ * @param config - Mapping configuration for transforming loading state values.
+ * @returns Mapped iteration instance with transformed state observables.
  */
 export declare function mapItemIteration<O, I = unknown, M extends LoadingState<O> = LoadingState<O>, L extends LoadingState<I> = LoadingState<I>, N extends ItemIteration<I, L> = ItemIteration<I, L>>(itemIterator: N, config: MappedItemIterationInstanceMapConfig<O, I, M, L>): MappedItemIterationInstance<O, I, M, L, N>;

package/src/lib/iterator/iteration.mapped.page.d.ts

@@ -16,8 +16,8 @@ export interface MappedPageItemIterationInstance<O, I = unknown, M extends PageL
  * and transforms its loading state values while preserving page-level operations
  * (nextPage, page load limits, latestLoadedPage).
  *
- * @param itemIteration - the source page iteration to wrap
- * @param config - mapping configuration for transforming loading state values
- * @returns mapped page iteration instance
+ * @param itemIteration - The source page iteration to wrap.
+ * @param config - Mapping configuration for transforming loading state values.
+ * @returns Mapped page iteration instance.
  */
 export declare function mappedPageItemIteration<O, I = unknown, M extends PageLoadingState<O> = PageLoadingState<O>, L extends PageLoadingState<I> = PageLoadingState<I>, N extends PageItemIteration<I, L> = PageItemIteration<I, L>>(itemIteration: N, config: MappedItemIterationInstanceMapConfig<O, I, M, L>): MappedPageItemIterationInstance<O, I, M, L, N>;

package/src/lib/iterator/iteration.next.d.ts

@@ -5,8 +5,8 @@ import { type Maybe, type GetterOrValue, type PageNumber } from '@dereekb/util';
  * Combines an iteration's `hasNext$` and `canLoadMore$` into a single observable that emits
  * `true` only when both conditions are met (more items exist and the page limit hasn't been reached).
  *
- * @param iteration - the iteration to check
- * @returns observable that emits `true` when more items can be loaded
+ * @param iteration - The iteration to check.
+ * @returns Observable that emits `true` when more items can be loaded.
  */
 export declare function iterationHasNextAndCanLoadMore<V>(iteration: ItemIteration<V>): Observable<boolean>;
 /**
@@ -14,22 +14,20 @@ export declare function iterationHasNextAndCanLoadMore<V>(iteration: ItemIterati
  *
  * Falls back to the provided default limit if no max is configured on the iterator.
  *
- * @param iterator - the page iteration to advance
- * @param defaultLimit - fallback page limit if none is configured (defaults to 100)
- * @returns promise resolving to the last loaded page number
- *
- * @throws {Error} If neither a max page load limit nor a default limit is defined
- * @throws Rejects if the iteration encounters a loading error
+ * @param iterator - The page iteration to advance.
+ * @param defaultLimit - Fallback page limit if none is configured (defaults to 100)
+ * @returns Promise resolving to the last loaded page number.
+ * @throws {Error} If neither a max page load limit nor a default limit is defined.
+ * @throws {Error} Rejects if the iteration encounters a loading error.
  */
 export declare function iteratorNextPageUntilMaxPageLoadLimit(iterator: PageItemIteration, defaultLimit?: Maybe<number>): Promise<number>;
 /**
  * Automatically pages through a {@link PageItemIteration} until the specified page number is reached,
  * respecting the iteration's max page load limit.
  *
- * @param iteration - the page iteration to advance
- * @param page - target page number (or getter returning one) representing total pages to load
- * @returns promise resolving to the last loaded page number
- *
- * @throws Rejects if the iteration encounters a loading error
+ * @param iteration - The page iteration to advance.
+ * @param page - Target page number (or getter returning one) representing total pages to load.
+ * @returns Promise resolving to the last loaded page number.
+ * @throws {Error} Rejects if the iteration encounters a loading error.
  */
 export declare function iteratorNextPageUntilPage(iteration: PageItemIteration, page: GetterOrValue<number>): Promise<PageNumber>;

package/src/lib/iterator/iterator.page.d.ts

@@ -113,8 +113,8 @@ export declare class ItemPageIterator<V, F, C extends ItemPageIterationConfig<F>
     /**
      * Creates a new iteration instance with the given configuration.
      *
-     * @param config - filter and page limit configuration for this iteration session
-     * @returns new iteration instance ready to begin loading pages
+     * @param config - Filter and page limit configuration for this iteration session.
+     * @returns New iteration instance ready to begin loading pages.
      */
     instance(config: C): ItemPageIterationInstance<V, F, C>;
 }
@@ -234,7 +234,7 @@ export declare class ItemPageIterationInstance<V, F, C extends ItemPageIteration
  * - `end` is not explicitly `false` and the result value is empty/null (via `hasValueOrNotEmpty`)
  * - Error results are never considered the end
  *
- * @param result - the page result to check
- * @returns `true` if this result indicates no more pages are available
+ * @param result - The page result to check.
+ * @returns `true` if this result indicates no more pages are available.
  */
 export declare function isItemPageIteratorResultEndResult<V>(result: ItemPageIteratorResult<V>): boolean;

package/src/lib/loading/loading.context.rxjs.d.ts

@@ -7,6 +7,8 @@ import { type Maybe } from '@dereekb/util';
  *
  * Useful for flattening an observable of optional loading contexts into a single stream of loading events.
  *
+ * @returns An RxJS operator that switches to the stream$ of each non-null LoadingContext.
+ *
  * @example
  * ```ts
  * const context$ = new BehaviorSubject<Maybe<LoadingContext>>(myLoadingContext);
@@ -17,7 +19,5 @@ import { type Maybe } from '@dereekb/util';
  * // emits LoadingContextEvent values from myLoadingContext.stream$
  * // emits undefined when context$ emits null/undefined
  * ```
- *
- * @returns an RxJS operator that switches to the stream$ of each non-null LoadingContext
  */
 export declare function switchMapMaybeLoadingContextStream(): OperatorFunction<Maybe<LoadingContext>, Maybe<LoadingContextEvent>>;

package/src/lib/loading/loading.context.simple.d.ts

@@ -29,7 +29,7 @@ export declare class SimpleLoadingContext implements LoadingContext, Destroyable
     /**
      * Whether the current state has a non-null error.
      *
-     * @returns true if the current state contains an error
+     * @returns True if the current state contains an error.
      */
     hasError(): boolean;
     /**
@@ -43,14 +43,14 @@ export declare class SimpleLoadingContext implements LoadingContext, Destroyable
     /**
      * Sets the loading flag and clears any existing error.
      *
-     * @param loading - whether loading is in progress (defaults to true)
+     * @param loading - Whether loading is in progress (defaults to true)
      */
     setLoading(loading?: boolean): void;
     /**
      * Sets an error state with an optional loading flag.
      *
-     * @param error - the error to set
-     * @param loading - whether loading is still in progress (defaults to false)
+     * @param error - The error to set.
+     * @param loading - Whether loading is still in progress (defaults to false)
      */
     setError(error: ReadableError, loading?: boolean): void;
 }

package/src/lib/loading/loading.context.state.d.ts

@@ -80,9 +80,9 @@ export type LoadingEventForLoadingPairConfigInput = Pick<LoadingStateContextConf
  * 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
+ * @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.
  */
 export declare const DEFAULT_LOADING_EVENT_FOR_LOADING_PAIR_FUNCTION: <T = unknown, S extends LoadingState<T> = LoadingState<T>, E extends LoadingStateContextEvent = LoadingContextEvent & S>(state: S, input: LoadingEventForLoadingPairConfigInput) => LoadingStateContextEvent<T>;
 /**
@@ -96,6 +96,9 @@ export type LoadingStateContextInput<T = unknown, S extends LoadingState<T> = Lo
  * Accepts either a raw observable or a {@link LoadingStateContextConfig} for fine-grained control
  * over how loading events are derived from the state.
  *
+ * @param input - Optional observable or config to initialize the context.
+ * @returns A mutable loading state context with reactive accessors.
+ *
  * @example
  * ```ts
  * // Create a context from a state observable
@@ -113,8 +116,5 @@ export type LoadingStateContextInput<T = unknown, S extends LoadingState<T> = Lo
  * // Clean up
  * context.destroy();
  * ```
- *
- * @param input - optional observable or config to initialize the context
- * @returns a mutable loading state context with reactive accessors
  */
 export declare function loadingStateContext<T = unknown, S extends LoadingState<T> = LoadingState<T>, E extends LoadingStateContextEvent = LoadingContextEvent & S>(input?: LoadingStateContextInput<T, S, E>): MutableLoadingStateContext<T, S, E>;

package/src/lib/loading/loading.context.state.list.d.ts

@@ -55,6 +55,9 @@ export type ListLoadingStateContextInput<L, S extends ListLoadingState<L> = List
  * Extends {@link loadingStateContext} with list-aware behavior, including optional array length limiting
  * via {@link LimitArrayConfig} and empty-state detection streams.
  *
+ * @param input - Optional observable or config to initialize the context.
+ * @returns A mutable list loading state context.
+ *
  * @example
  * ```ts
  * const context = listLoadingStateContext<string>();
@@ -72,8 +75,5 @@ export type ListLoadingStateContextInput<L, S extends ListLoadingState<L> = List
  *
  * context.destroy();
  * ```
- *
- * @param input - optional observable or config to initialize the context
- * @returns a mutable list loading state context
  */
 export declare function listLoadingStateContext<L, S extends ListLoadingState<L> = ListLoadingState<L>>(input?: ListLoadingStateContextInput<L, S>): MutableListLoadingStateContext<L, S>;