@dereekb/dbx-core 13.0.4 → 13.0.6

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dereekb/dbx-core",
-  "version": "13.0.4",
+  "version": "13.0.6",
   "peerDependencies": {
     "@angular/common": "^21.0.0",
     "@angular/core": "^21.0.0",
     "@angular/router": "^21.0.0",
-    "@dereekb/date": "13.0.4",
-    "@dereekb/rxjs": "13.0.4",
-    "@dereekb/util": "13.0.4",
+    "@dereekb/date": "13.0.6",
+    "@dereekb/rxjs": "13.0.6",
+    "@dereekb/util": "13.0.6",
     "@ngrx/component-store": "^21.0.0",
     "@ngrx/effects": "^21.0.0",
     "@ngrx/store": "^21.0.0",

package/types/dereekb-dbx-core.d.ts

@@ -3482,6 +3482,15 @@ declare function provideDbxStorage(): EnvironmentProviders;
  * when the DestroyRef is destroyed in the context.
  *
  * Must be run in an Angular injection context.
+ *
+ * @example
+ * // Clean up a Destroyable object (e.g., SubscriptionObject, LockSet):
+ * const sub = new SubscriptionObject(obs$.subscribe(handler));
+ * clean(sub);
+ *
+ * @example
+ * // Clean up a destroy function directly:
+ * clean(() => resource.release());
  */
 declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
 /**
@@ -3489,6 +3498,14 @@ declare function clean<T extends Destroyable | DestroyFunction>(input: T): T;
  * when the DestroyRef is destroyed in the context.
  *
  * Must be run in an Angular injection context.
+ *
+ * @example
+ * // Complete a BehaviorSubject when the component is destroyed:
+ * readonly value$ = completeOnDestroy(new BehaviorSubject<string>('initial'));
+ *
+ * @example
+ * // Complete a ReplaySubject when the component is destroyed:
+ * readonly events$ = completeOnDestroy(new ReplaySubject<Event>(1));
  */
 declare function completeOnDestroy<T extends Pick<Subject<any>, 'complete' | 'error'>>(input: T): T;
 
@@ -3514,7 +3531,17 @@ type CleanLockSet = LockSet & {
  *
  * Must be run within an Angular injection context.
  *
- * @param onLockSetDestroy Optional callback to run when the lockset is unlocked.
+ * @param config Optional configuration for destruction behavior and callbacks.
+ *
+ * @example
+ * // Create a simple lockset:
+ * readonly lockSet = cleanLockSet();
+ *
+ * @example
+ * // Create with a callback when the lockset is destroyed:
+ * readonly lockSet = cleanLockSet({
+ *   onLockSetDestroy: () => console.log('lockset destroyed')
+ * });
  */
 declare function cleanLockSet(config?: Maybe<CleanLockSetConfig>): CleanLockSet;
 /**
@@ -3524,6 +3551,10 @@ declare function cleanLockSet(config?: Maybe<CleanLockSetConfig>): CleanLockSet;
  *
  * @param lockSet The lockset to use.
  * @param onDestroy The function to run when the lockset is unlocked.
+ *
+ * @example
+ * // Defer cleanup until the lockset unlocks after component destroy:
+ * cleanWithLockSet(this.lockSet, () => resource.release());
  */
 declare function cleanWithLockSet(lockSet: LockSet, onDestroy: DestroyFunction): void;
 /**
@@ -3537,6 +3568,18 @@ interface CleanSubscriptionWithLockSetConfig<T extends Unsubscribable = Unsubscr
  * Creates a new SubscriptionObject that is automatically destroyed when the context is destroyed, and the lock set's next unlock occurs.
  *
  * Must be run within an Angular injection context.
+ *
+ * @example
+ * // Pass a subscription that waits for the lockset to unlock before cleanup:
+ * readonly _sub = cleanSubscriptionWithLockSet({
+ *   lockSet: this.lockSet,
+ *   sub: obs$.subscribe(handler)
+ * });
+ *
+ * @example
+ * // Create first, then set the subscription later:
+ * readonly _sub = cleanSubscriptionWithLockSet({ lockSet: this.lockSet });
+ * this._sub.subscription = obs$.subscribe(handler);
  */
 declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubscribable>(input: CleanSubscriptionWithLockSetConfig<T>): SubscriptionObject<T>;
 
@@ -3544,6 +3587,14 @@ declare function cleanSubscriptionWithLockSet<T extends Unsubscribable = Unsubsc
  * Creates a new SubscriptionObject that is automatically destroyed when the context is destroyed.
  *
  * Must be run within an Angular injection context.
+ *
+ * @example
+ * // Pass a subscription directly - it will be cleaned up automatically:
+ * cleanSubscription(obs$.subscribe(handler));
+ *
+ * // Or create first, then set the subscription later:
+ * readonly _sub = cleanSubscription();
+ * this._sub.subscription = obs$.subscribe(handler);
  */
 declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(sub?: Maybe<GetterOrValue<T>>): SubscriptionObject<T>;
 
@@ -3551,12 +3602,30 @@ declare function cleanSubscription<T extends Unsubscribable = Unsubscribable>(su
  * Creates a new LoadingStateContext that is automatically destroyed when the context is destroyed.
  *
  * Must be run within an Angular injection context.
+ *
+ * @example
+ * // Create with an observable source:
+ * readonly context = cleanLoadingContext<MyData>(this.data$);
+ *
+ * @example
+ * // Create empty, then set the observable source later:
+ * readonly context = cleanLoadingContext<MyData>();
+ * this.context.obs = this.data$;
  */
 declare function cleanLoadingContext<T = unknown, S extends LoadingState<T> = LoadingState<T>, E extends LoadingContextEvent = LoadingContextEvent & S>(input?: LoadingStateContextInput<T, S, E>): MutableLoadingStateContext<T, S, E>;
 /**
  * Creates a new ListLoadingStateContext that is automatically destroyed when the context is destroyed.
  *
  * Must be run within an Angular injection context.
+ *
+ * @example
+ * // Create with an observable source:
+ * readonly listContext = cleanListLoadingContext<MyItem>(this.items$);
+ *
+ * @example
+ * // Create empty, then set the observable source later:
+ * readonly listContext = cleanListLoadingContext<MyItem>();
+ * this.listContext.obs = this.items$;
  */
 declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState<L> = ListLoadingState<L>>(input?: ListLoadingStateContextInput<L, S>): MutableListLoadingStateContext<L, S>;
 
@@ -3564,6 +3633,15 @@ declare function cleanListLoadingContext<L = unknown, S extends ListLoadingState
  * Creates a new DestroyFunctionObject that is automatically destroyed when the context is destroyed.
  *
  * Must be run within an Angular injection context.
+ *
+ * @example
+ * // Pass a destroy function directly:
+ * cleanDestroy(() => resource.release());
+ *
+ * @example
+ * // Create first, then set the destroy function later:
+ * readonly _destroy = cleanDestroy();
+ * this._destroy.setDestroyFunction(() => resource.release());
  */
 declare function cleanDestroy(input?: Maybe<DestroyFunction>): DestroyFunctionObject;