@dereekb/rxjs 12.6.21 → 12.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/rxjs",
-  "version": "12.6.21",
+  "version": "12.7.0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/lock.d.ts

@@ -1,26 +1,27 @@
 import { type ObservableOrValue } from './rxjs/getter';
-import { type Observable, type Subscription } from 'rxjs';
+import { type Subscription, type Observable } from 'rxjs';
 import { type Destroyable, type Maybe } from '@dereekb/util';
 export type LockKey = string;
 export type OnLockSetUnlockedFunction = (unlocked: boolean) => void;
 export type RemoveLockFunction = () => void;
 export interface OnLockSetUnlockedConfig {
-    lockSet: LockSet;
-    fn: OnLockSetUnlockedFunction;
-    timeout?: Maybe<number>;
-    delayTime?: Maybe<number>;
+    readonly lockSet: LockSet;
+    readonly fn?: Maybe<OnLockSetUnlockedFunction>;
+    readonly timeout?: Maybe<number>;
+    readonly delayTime?: Maybe<number>;
 }
+export type DestroyOnNextUnlockConfig = Omit<OnLockSetUnlockedConfig, 'lockSet'>;
 export interface SetLockedConfig {
     /**
      * Whether or not to lock the config.
      */
-    locked?: boolean;
+    readonly locked?: boolean;
     /**
      * Optional duration to set the locked state.
      *
      * Only relevant for locking.
      */
-    duration?: number;
+    readonly duration?: number;
 }
 export declare const DEFAULT_LOCK_SET_TIME_LOCK_KEY = "timelock";
 /**
@@ -34,14 +35,16 @@ export declare function onLockSetNextUnlock({ lockSet, fn, timeout: inputTimeout
  */
 export declare class LockSet implements Destroyable {
     private static LOCK_SET_CHILD_INDEX_STEPPER;
-    private _locks;
-    private _parentSub;
+    private readonly _onDestroy;
+    private readonly _locks;
+    private readonly _parentSub;
     readonly locks$: Observable<Map<string, Observable<boolean>>>;
     /**
      * isLocked$ is true if any observable is emitting true.
      */
     readonly isLocked$: Observable<boolean>;
     readonly isUnlocked$: Observable<boolean>;
+    readonly onDestroy$: Observable<void>;
     private get locks();
     setLocked(key: LockKey, config: SetLockedConfig): void;
     setLocked(key: LockKey, config: boolean, duration?: number): void;
@@ -56,6 +59,6 @@ export declare class LockSet implements Destroyable {
      * Convenience function for watching a child lockset's locked state and propogating it upward.
      */
     addChildLockSet(lockSet: LockSet, key?: LockKey): RemoveLockFunction;
-    destroyOnNextUnlock(config?: OnLockSetUnlockedFunction | Omit<OnLockSetUnlockedConfig, 'lockSet'>, delayTime?: number): void;
+    destroyOnNextUnlock(config?: Maybe<DestroyOnNextUnlockConfig['fn'] | DestroyOnNextUnlockConfig>, delayTime?: number): void;
     destroy(): void;
 }